CollectionsAndKeys

KVNode 将数据组织到集合中，每个集合包含键值对。本文档详细介绍集合管理和键操作。

集合管理

创建集合

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"}

集合会立即创建。如果集合已存在，则该操作是幂等的。

列出集合

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

GET /v1/collections 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", 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',
    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",
    headers=headers
)

print(response.text)

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

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

const response = await fetch("https://api.hola.cloud/v1/collections", {
  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"))
            .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{"collections":["my-collection","config","sessions"]}

删除集合

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

DELETE /v1/collections/my-collection 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", 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',
    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",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection", {
  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", {
  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"))
            .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());
    }
}

响应：

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

删除集合将移除其中存储的所有键。此操作不可撤销。

键操作

KVNode 的键是字符串，可以包含任何 UTF-8 字符。值必须是有效的 JSON。

设置键

curl -X POST "https://api.hola.cloud/v1/collections/my-collection/keys/settings:theme" \
  -H "apikey: 你的API密钥" \
  -H "secret: 你的API密钥secret" \
  -d '{"value": {"mode": "dark", "fontSize": 14}}'

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

{"value": {"mode": "dark", "fontSize": 14}}

package main

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

func main() {
	payload := map[string]any{"value": map[string]any{"fontSize": 14, "mode": "dark"}}
	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/settings:theme", 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' => ['fontSize' => 14, 'mode' => 'dark']];
$body = json_encode($payload);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.hola.cloud/v1/collections/my-collection/keys/settings:theme',
    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": {"fontSize": 14, "mode": "dark"}}
body = json.dumps(payload)

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

print(response.text)

const payload = {"value": {"fontSize": 14, "mode": "dark"}};

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

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

const payload = {"value": {"fontSize": 14, "mode": "dark"}};

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/settings:theme", {
  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("fontSize", 14, "mode", "dark"));
        var body = new ObjectMapper().writeValueAsString(payload);

        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.hola.cloud/v1/collections/my-collection/keys/settings:theme"))
            .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":3,"version":1}

每次成功写入都会返回单调递增的 seq（全局序列号）和 version（每个键的版本号），可用于乐观并发控制。

获取键

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

GET /v1/collections/my-collection/keys/settings:theme 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/settings:theme", 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/settings:theme',
    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/settings:theme",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/settings:theme", {
  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/settings:theme", {
  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/settings:theme"))
            .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":"settings:theme","value":{"mode":"dark","fontSize":14},"version":1,"updatedAt":"2025-01-01T00:00:00Z"}

尝试获取不存在的键将返回 404 错误。

删除键

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

DELETE /v1/collections/my-collection/keys/settings:theme 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/settings:theme", 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/settings:theme',
    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/settings:theme",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys/settings:theme", {
  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/settings:theme", {
  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/settings:theme"))
            .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());
    }
}

响应：

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

按前缀和限制列出键

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

GET /v1/collections/my-collection/keys?prefix=settings:&limit=20 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=settings:&limit=20", 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=settings:&limit=20',
    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=settings:&limit=20",
    headers=headers
)

print(response.text)

const response = await fetch("https://api.hola.cloud/v1/collections/my-collection/keys?prefix=settings:&limit=20", {
  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=settings:&limit=20", {
  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=settings:&limit=20"))
            .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());
    }
}

prefix 和 limit 都是可选的查询参数：

prefix — 过滤以指定字符串开头的键
limit — 限制返回的记录数量（默认：无限制）

响应：

1[
2  {"key":"settings:theme","value":{"mode":"dark","fontSize":14},"version":1,"updatedAt":"2025-01-01T00:00:00Z"},
3  {"key":"settings:locale","value":"en-US","version":1,"updatedAt":"2025-01-01T00:00:01Z"}
4]