EdgeKVGet
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to batch read key values from a specified namespace, supporting a single query of up to 20 keys.
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: EdgeKVGet. |
| 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. You can obtain the list of namespaces under the site through the DescribeEdgeKVNamespaces API. |
| Keys.N | Yes | Array of String | Name list. Maximum array length is 20. Each key cannot be empty, with a length of 1-512 characters, and supports valid UTF-8 characters. When querying a single key, input an array with one element. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of KeyValuePair | Key-value pair data list. Return results sequentially in the order of input Keys. If a key does not exist, the corresponding Value Field returns empty string. |
| 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 EdgeKV key-value pairs
Query the content of the key-value pair named hello 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: EdgeKVGet
<Common request parameters>
{
"ZoneId": "zone-3j1xw7910arp",
"Namespace": "ns-011",
"Keys": [
"hello"
]
}
Output Example
{
"Response": {
"Data": [
{
"Expiration": "2026-03-26T08:20:00Z",
"Key": "hello",
"Value": "world"
}
],
"RequestId": "07aea30b-d34f-4480-b14c-ffb4f7e10555"
}
}
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. |
| InvalidParameter.KeysTooMany | The number of keys in the request exceeds the limit. |
| ResourceUnavailable.NamespaceNotFound | KV namespace does not exist. |