Sets key-value pairs in a namespace.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Namespace | string | Yes | The name of the namespace. | ns1 |
| Key | string | Yes | The key. The key can be up to 512 characters in length, and cannot contain spaces. | key1 |
| Value | string | Yes | The value of the key. The maximum size is 2 MB (2 x 1000 x 1000 bytes). | value1 |
| Expiration | long | No | The time when the key expires.Example: "1690081381". | 1690081381 |
| ExpirationTtl | long | No | The time when the key expires.Example: "3600". | 3600 |
Response parameters
Examples
Sample success responses
JSONformat
{
"Length": 5,
"Value": "value1",
"RequestId": "96ED3127-EC7A-57C5-AFA6-A689B24B2530"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Invalid.Parameter | The specified parameter is invalid. | The parameter is set to an invalid value. |
| 400 | InvalidAccount.Malformed | The specified account is invalid. | The account is invalid. Check whether an account is specified. |
| 400 | InvalidNameSpace.Malformed | The specified namespace is invalid. | The namespace is invalid. Check whether a namespace is specified. |
| 400 | InvalidKey.Malformed | The specified key is invalid. | The key is invalid. Check whether a key is specified. |
| 400 | InvalidKey.ExceedsMaximum | The size of the key cannot exceed 512 bytes. | The key cannot exceed 512 bytes in length. |
| 400 | InvalidValue.ExceedsMaximum | The size of the value cannot exceed 2,000,000 bytes. | The value cannot exceed 2,000,000 bytes in length. |
| 403 | InvalidKey.ExceedsCapacity | The maximum capacity of a single namespace cannot exceed 1 GB. | The capacity of the namespace has reached the upper limit. Each namespace can be at most 1 GB. |
| 403 | Unauthorized.InvalidParameters | The specified authentication parameters are invalid. | An authentication parameter is set to an invalid value. |
| 403 | Unauthorized.InvalidTime | The specified authentication time is invalid. | The authentication time parameter you entered is invalid. Check the parameter value and try again. |
| 403 | Unauthorized.InvalidToken | Token authentication failed. | The token you entered is invalid. Please check and enter the correct token and try again. |
| 403 | Unauthorized.InvalidResource | Resource authentication failed. | The specified resource is invalid. |
| 404 | InvalidAccount.NotFound | The specified account does not exist. | The specified account does not exist. |
| 404 | InvalidNameSpace.NotFound | The specified namespace does not exist. | The specified namespace does not exist. |
| 404 | InvalidKey.NotFound | The specified key does not exist. | The specified key does not exist. |
| 406 | InvalidNameSpace.Duplicate | The specified namespace already exists. | The namespace already exists. |
| 406 | InvalidNameSpace.QuotaFull | The maximum number of namespaces is exceeded. | The number of namespaces has reached the upper limit. |
| 406 | InvalidKey.QuotaFull | The maximum number of keys is exceeded. | The number of keys has reached the upper limit. |
| 429 | TooManyRequests | Too many requests are submitted. | Do not send requests at a high frequency. |
| 429 | TooQuickRequests | Request for putting or deleting keys are frequently submitted. | Do not perform the key put/delete operation at a high frequency. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-20 | API Description Update. The Error code has changed. The request parameters of the API has changed | View Change Details |