查询 KV 键名列表

最近更新时间:2026-04-06 02:16:53

我的收藏

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

本接口用于列出指定命名空间下的所有键名,支持前缀过滤。通过 Cursor 实现游标遍历,返回下一个游标用于继续查询。适用于遍历命名空间中的所有键。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:EdgeKVList。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
Namespace String 命名空间名称。
Prefix String 键名前缀过滤。只返回以指定前缀开头的键名,长度为 1-512 个字符。不填写表示返回所有键名;不允许传入空字符串。
Cursor String 游标位置。标识当前查询的起始位置,用于遍历大量数据。首次查询时不填写,从头开始遍历;后续查询时填写上一次返回的 Cursor 值,从该位置继续向后遍历。
Limit Integer 返回的键名数量。默认值:20,最大值:1000。

3. 输出参数

参数名称 类型 描述
Keys Array of String 键名列表。
Cursor String 游标位置。标识当前遍历的位置,用于获取下一批数据。将此值填入下次请求的 Cursor 参数中,可继续向后遍历。若为空字符串,表示已遍历完所有数据。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 列举 EdgeKV 键列表(首次查询)

列举站点 zone-3j1xw7910arp 的命名空间 ns-011 中前缀为 he 的键列表,每次返回 1 条。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EdgeKVList
<公共请求参数>

{
    "ZoneId": "zone-3j1xw7910arp",
    "Namespace": "ns-011",
    "Prefix": "he",
    "Limit": 1
}

输出示例

{
    "Response": {
        "Cursor": "hello",
        "Keys": [
            "hello"
        ],
        "RequestId": "3be98a20-737d-488d-aeb3-85ebc95288fc"
    }
}

示例2 列举 EdgeKV 键列表(翻页查询)

使用上一次查询返回的 Cursor 值 hello 继续列举站点 zone-3j1xw7910arp 的命名空间 ns-011 中前缀为 he 的下一页键列表。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EdgeKVList
<公共请求参数>

{
    "ZoneId": "zone-3j1xw7910arp",
    "Namespace": "ns-011",
    "Prefix": "he",
    "Cursor": "hello",
    "Limit": 1
}

输出示例

{
    "Response": {
        "Cursor": "",
        "Keys": [
            "hello1"
        ],
        "RequestId": "bc3370e5-a969-4760-ada8-e9071084f047"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue 参数取值错误。
ResourceUnavailable.NamespaceNotFound KV命名空间不存在。