EdgeKVList
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to list all keys in the specified namespace with prefix filtering support. It implements cursor traversal through Cursor and returns the next cursor to proceed with querying. Suitable for traversal of all keys in the namespace.
A maximum of 20 requests can be initiated per second for this API.
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: EdgeKVList. |
| 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. |
| Namespace | Yes | String | Namespace name. |
| Prefix | No | String | Prefix filtering for key names. Only return key names that begin with the specified prefix, with a length of 1-512 characters. Not specified means return all key names; does not allow input of empty string. |
| Cursor | No | String | Cursor position. Indicates the starting position of the current query for traversing large amounts of data. Do not fill in during the initial query, start traversal from the beginning. Fill in the Cursor value returned last time during follow-up queries to proceed with traversal from that position. |
| Limit | No | Integer | Number of key names returned. Default value: 20. Maximum value: 1000. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Keys | Array of String | Key name list. |
| Cursor | String | Cursor position. Indicates current traversal position to obtain next batch data. Fill in this value for the Cursor parameter in the next request to proceed with backward traversal. If it is an empty string, it means all data has been traversed. |
| 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 Listing EdgeKV Key List (Initial Query)
List the key list prefixed with he in namespace ns-011 of site zone-3j1xw7910arp, returning 1 entry each time.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EdgeKVList
<Common request parameters>
{
"ZoneId": "zone-3j1xw7910arp",
"Namespace": "ns-011",
"Prefix": "he",
"Limit": 1
}
Output Example
{
"Response": {
"Cursor": "hello",
"Keys": [
"hello"
],
"RequestId": "3be98a20-737d-488d-aeb3-85ebc95288fc"
}
}
Example2 Listing EdgeKV Key List (Paginated Query)
Use the Cursor value hello returned by the previous query to list the next page of the key list prefixed with he in namespace ns-011 of site zone-3j1xw7910arp.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EdgeKVList
<Common request parameters>
{
"ZoneId": "zone-3j1xw7910arp",
"Namespace": "ns-011",
"Prefix": "he",
"Cursor": "hello",
"Limit": 1
}
Output Example
{
"Response": {
"Cursor": "",
"Keys": [
"hello1"
],
"RequestId": "bc3370e5-a969-4760-ada8-e9071084f047"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
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. |
| InvalidParameterValue | Invalid parameter value. |
| ResourceUnavailable.NamespaceNotFound | KV namespace does not exist. |