当前内容仅提供英语版本，中文版我们将尽快补充，感谢您的理解。

DescribeEdgeKVNamespaces

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to query the KV namespace list of a specified site, supporting pagination, sorting and conditional filtering. It returns the basic info, capacity utilization and reference relationship of namespaces. If data not found, return an empty array.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeEdgeKVNamespaces.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Zone ID.
Offset	No	Integer	The offset of paginated query. Default value: 0.
Limit	No	Integer	The limit of paginated query. Default value: 20. Maximum value: 1,000.
SortBy	No	String	Sorting basis. Valid values: created-on: creation time; updated-on: Update time. Default value is created-on.
SortOrder	No	String	List sort method. Valid values: asc: ascending order; desc: descending order. Default value is desc.
Filters.N	No	Array of AdvancedFilter	Filter criteria. The maximum of Filters.Values is 20. If this parameter is left empty, return all KV namespaces under the site ID. Detailed filter criteria: Namespace: Filter by KV namespace name. Fuzzy query is supported. remark: Filter by namespace description. Fuzzy query is supported.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of eligible namespaces.
KVNamespaces	Array of KVNamespace	KV namespace information list. If no matching criteria, return an empty array.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the EdgeKV namespace list

Query the EdgeKV namespace list under site zone-3j1xw7910arp, starting from record 0, with 10 records to be returned per page, sorted in descending order by creation time.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEdgeKVNamespaces
<Common request parameters>

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

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InvalidParameter.InvalidFilterName	Invalid filter field.
InvalidParameter.InvalidSortBy	Invalid sorting order field.
InvalidParameter.InvalidSortOrder	Invalid sorting order.
InvalidParameterValue	Invalid parameter value.
LimitExceeded.NamespaceLimitExceeded	The number of KV namespaces in the site has reached the upper limit.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Querying the EdgeKV namespace list
5. Developer Resources
SDK
Command Line Interface
6. Error Code