GettingStarted

本指南将带您了解 KVNode 的基本操作：健康检查、集合管理以及键值操作。

健康检查

验证节点是否正常运行：

curl "https://api.hola.cloud/healthz"

GET /healthz HTTP/1.1
Host: api.hola.cloud

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/healthz", nil)
	if err != nil {
		panic(err)
	}

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/healthz',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

response = requests.request(
    "GET",
    "https://api.hola.cloud/healthz"
)

print(response.text)

const response = await fetch("https://api.hola.cloud/healthz", {
  method: "GET"
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/healthz", {
  method: "GET"
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/healthz"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

预期响应：

1{"ok":true,"node":"node-1","role":"primary"}

就绪检查

检查节点是否已准备好处理流量（检查副本的父节点连接）：

curl "https://api.hola.cloud/readyz"

GET /readyz HTTP/1.1
Host: api.hola.cloud

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/readyz", nil)
	if err != nil {
		panic(err)
	}

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/readyz',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

response = requests.request(
    "GET",
    "https://api.hola.cloud/readyz"
)

print(response.text)

const response = await fetch("https://api.hola.cloud/readyz", {
  method: "GET"
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/readyz", {
  method: "GET"
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/readyz"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

就绪时的预期响应：

1{"ok":true,"node":"node-1","role":"primary","ready":true,"checks":{"wal_replayed":true,"parent_connected":true}}

创建集合

集合是键值对的容器。通过 POST 请求创建一个集合：

curl -X POST "https://api.hola.cloud/v1/collections" \
  -H "apikey: 你的API密钥" \
  -H "secret: 你的API密钥secret" \
  -d '{"name": "my-collection"}'

POST /v1/collections HTTP/1.1
Host: api.hola.cloud
apikey: 你的API密钥
secret: 你的API密钥secret

{"name": "my-collection"}

package main

import (
	"fmt"
	"io"
	"net/http"
	"encoding/json"
	"strings"
)

func main() {
	payload := map[string]any{"name": "my-collection"}
	bodyBytes, err := json.Marshal(payload)
	if err != nil {
		panic(err)
	}
	body := string(bodyBytes)

	req, err := http.NewRequest("POST", "https://api.hola.cloud/v1/collections", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "你的API密钥")
	req.Header.Set("secret", "你的API密钥secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$payload = ['name' => 'my-collection'];
$body = json_encode($payload);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => [
        'apikey: 你的API密钥',
        'secret: 你的API密钥secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

import json

headers = {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret",
}

payload = {"name": "my-collection"}
body = json.dumps(payload)

response = requests.request(
    "POST",
    "https://api.hola.cloud/v1/collections",
    headers=headers,
    data=body
)

print(response.text)

const payload = {"name": "my-collection"};

const response = await fetch("https://api.hola.cloud/v1/collections", {
  method: "POST",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  },
  body: JSON.stringify(payload)
});

console.log(await response.text());

const payload = {"name": "my-collection"};

const response = await fetch("https://api.hola.cloud/v1/collections", {
  method: "POST",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  },
  body: JSON.stringify(payload)
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
import java.util.List;

public class Main {
    public static void main(String[] args) throws Exception {
        var payload = Map.of("name", "my-collection");
        var body = new ObjectMapper().writeValueAsString(payload);

        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections"))
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .header("apikey", "你的API密钥")
            .header("secret", "你的API密钥secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

预期响应：

1{"ok":true,"collection":"my-collection"}

设置键值对

在集合中的某个键下存储 JSON 值：

curl -X POST "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice" \
  -H "apikey: 你的API密钥" \
  -H "secret: 你的API密钥secret" \
  -d '{"value": {"user": "alice", "role": "admin"}}'

POST /v1/collections/my-collection/keys/user:alice HTTP/1.1
Host: api.hola.cloud
apikey: 你的API密钥
secret: 你的API密钥secret

{"value": {"user": "alice", "role": "admin"}}

package main

import (
	"fmt"
	"io"
	"net/http"
	"encoding/json"
	"strings"
)

func main() {
	payload := map[string]any{"value": map[string]any{"role": "admin", "user": "alice"}}
	bodyBytes, err := json.Marshal(payload)
	if err != nil {
		panic(err)
	}
	body := string(bodyBytes)

	req, err := http.NewRequest("POST", "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", strings.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "你的API密钥")
	req.Header.Set("secret", "你的API密钥secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$payload = ['value' => ['role' => 'admin', 'user' => 'alice']];
$body = json_encode($payload);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/my-collection/keys/user:alice',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => [
        'apikey: 你的API密钥',
        'secret: 你的API密钥secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

import json

headers = {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret",
}

payload = {"value": {"role": "admin", "user": "alice"}}
body = json.dumps(payload)

response = requests.request(
    "POST",
    "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice",
    headers=headers,
    data=body
)

print(response.text)

const payload = {"value": {"role": "admin", "user": "alice"}};

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", {
  method: "POST",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  },
  body: JSON.stringify(payload)
});

console.log(await response.text());

const payload = {"value": {"role": "admin", "user": "alice"}};

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", {
  method: "POST",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  },
  body: JSON.stringify(payload)
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
import java.util.List;

public class Main {
    public static void main(String[] args) throws Exception {
        var payload = Map.of("value", Map.of("role", "admin", "user", "alice"));
        var body = new ObjectMapper().writeValueAsString(payload);

        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice"))
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .header("apikey", "你的API密钥")
            .header("secret", "你的API密钥secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

预期响应：

1{"ok":true,"seq":1,"version":1}

获取键

检索特定键的值：

curl "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice" \
  -H "apikey: 你的API密钥" \
  -H "secret: 你的API密钥secret"

GET /v1/collections/my-collection/keys/user:alice HTTP/1.1
Host: api.hola.cloud
apikey: 你的API密钥
secret: 你的API密钥secret

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "你的API密钥")
	req.Header.Set("secret", "你的API密钥secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/my-collection/keys/user:alice',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'apikey: 你的API密钥',
        'secret: 你的API密钥secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

headers = {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret",
}

response = requests.request(
    "GET",
    "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", {
  method: "GET",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  }
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", {
  method: "GET",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  }
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .header("apikey", "你的API密钥")
            .header("secret", "你的API密钥secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

预期响应：

1{"key":"user:alice","value":{"user":"alice","role":"admin"},"version":1,"updatedAt":"2025-01-01T00:00:00Z"}

按前缀列出键

列出集合中的所有键，可按前缀过滤并限制数量：

curl "https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10" \
  -H "apikey: 你的API密钥" \
  -H "secret: 你的API密钥secret"

GET /v1/collections/my-collection/keys?prefix=user:&limit=10 HTTP/1.1
Host: api.hola.cloud
apikey: 你的API密钥
secret: 你的API密钥secret

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "你的API密钥")
	req.Header.Set("secret", "你的API密钥secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'apikey: 你的API密钥',
        'secret: 你的API密钥secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

headers = {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret",
}

response = requests.request(
    "GET",
    "https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10", {
  method: "GET",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  }
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10", {
  method: "GET",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  }
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/my-collection/keys?prefix=user:&limit=10"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .header("apikey", "你的API密钥")
            .header("secret", "你的API密钥secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

预期响应：

1[{"key":"user:alice","value":{"user":"alice","role":"admin"},"version":1}]

删除键

从集合中删除一个键：

curl -X DELETE "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice" \
  -H "apikey: 你的API密钥" \
  -H "secret: 你的API密钥secret"

DELETE /v1/collections/my-collection/keys/user:alice HTTP/1.1
Host: api.hola.cloud
apikey: 你的API密钥
secret: 你的API密钥secret

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("DELETE", "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "你的API密钥")
	req.Header.Set("secret", "你的API密钥secret")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(responseBody))
}

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/my-collection/keys/user:alice',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'apikey: 你的API密钥',
        'secret: 你的API密钥secret',
    ],
]);

$response = curl_exec($ch);
if ($response === false) {
    throw new Exception(curl_error($ch));
}
curl_close($ch);

echo $response;

import requests

headers = {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret",
}

response = requests.request(
    "DELETE",
    "https://api.hola.cloud/v1/collections/my-collection/keys/user:alice",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", {
  method: "DELETE",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  }
});

console.log(await response.text());

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice", {
  method: "DELETE",
  headers: {
    "apikey": "你的API密钥",
    "secret": "你的API密钥secret"
  }
});

const text = await response.text();
console.log(text);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/my-collection/keys/user:alice"))
            .method("DELETE", HttpRequest.BodyPublishers.noBody())
            .header("apikey", "你的API密钥")
            .header("secret", "你的API密钥secret")
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

预期响应：