文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>边缘安全加速平台 EO>API 文档>KV 存储相关接口>查询 KV 命名空间

查询 KV 命名空间

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

我的收藏

本页目录：

1. 接口描述

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

查询指定站点下的 KV 命名空间列表，支持分页、排序和条件过滤。返回命名空间的基本信息、存储容量使用情况以及被引用关系。若查询不到数据，则返回空数组。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeEdgeKVNamespaces。
Version 是 String 公共参数，本接口取值：2022-09-01。
Region 否 String 公共参数，此参数为可选参数。
ZoneId 是 String 站点 ID。
Offset 否 Integer 分页查询偏移量。默认值：0。
Limit 否 Integer 分页查询限制数目。默认值：20，最大值：1000。
SortBy 否 String 排序依据，取值有：
  • created-on：创建时间；
  • updated-on：更新时间。

    • 默认值为 created-on。
    SortOrder 否 String 列表排序方式，取值有：
  • asc：升序排列；
  • desc：降序排列。

    • 默认值为 desc。
    Filters.N 否 Array of AdvancedFilter 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回站点 ID 下全部 KV 命名空间。详细的过滤条件如下：
  • namespace：按照 KV 命名空间名称进行过滤，支持模糊查询；
  • remark：按照命名空间描述进行过滤，支持模糊查询。

    		•

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的命名空间总数。
    KVNamespaces Array of KVNamespace KV 命名空间信息列表。若无符合条件的命名空间，则返回空数组。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询 EdgeKV 命名空间列表

    查询站点 zone-3j1xw7910arp 下的 EdgeKV 命名空间列表，从第 0 条开始，每页返回 10 条，按创建时间降序排列。

    输入示例

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

{
    "ZoneId": "zone-3j1xw7910arp",
    "Offset": 0,
    "Limit": 10,
    "SortBy": "created-on",
    "SortOrder": "desc"
}

    输出示例

    {
    "Response": {
        "KVNamespaces": [
            {
                "Capacity": 1073741824,
                "CapacityUsed": 0,
                "CreatedOn": "2026-03-25T17:16:01+08:00",
                "ModifiedOn": "2026-03-25T17:16:01+08:00",
                "Namespace": "ns-011",
                "References": [],
                "Remark": "remark"
            }
        ],
        "TotalCount": 9,
        "RequestId": "ce0353db-f6f6-48ee-8275-50e1ebf990e8"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InvalidParameter.InvalidFilterName 不合法的过滤字段。
    InvalidParameter.InvalidSortBy 排序字段不合法。
    InvalidParameter.InvalidSortOrder 排序方向不合法。
    InvalidParameterValue 参数取值错误。
    LimitExceeded.NamespaceLimitExceeded 站点下 KV 命名空间数量已达上限
    中国站