BatchPutKv - Edge Security Acceleration - Alibaba Cloud Documentation Center

Configures key-value pairs for a namespace at a time based on specified keys.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:BatchPutKv	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The name of the namespace that you specify when you call the CreateKvNamespace operation.	test_namespace
KvList	array<object>	Yes	The key-value pairs that you want to configure at a time. The total size can be up to 2 MB (2 × 1000 × 1000).
	object	Yes
Key	string	Yes	The key name. The name can be up to 512 characters in length and cannot contain spaces or backslashes (\).	test_key
Value	string	Yes	The key content.	test_value
Expiration	long	No	The time when the key-value pair expires, which cannot be earlier than the current time. The value is a timestamp in seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.	1690081381
ExpirationTtl	long	No	The relative expiration time. Unit: seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.	3600

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
FailKeys	array	The keys that failed to be written.
failKeys	string	The name of the key that failed to be written.	test_key1
SuccessKeys	array	The keys that were written.
successKeys	string	The name of the key that was written.	test_key2

Examples

Sample success responses

JSONformat

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "FailKeys": [
    "test_key1"
  ],
  "SuccessKeys": [
    "test_key2"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccount.Malformed	The specified account is invalid.	The account number is not entered correctly, for example, the input is empty.
400	InvalidNameSpace.Malformed	The specified namespace is invalid.	The bucket name is entered incorrectly, such as an empty string.
400	InvalidKey.Malformed	The specified key is invalid.	Key name input error, such as entering an empty string.
400	InvalidKey.ExceedsMaximum	The size of the key cannot exceed 512 bytes.	The length of the requested key is too large.
400	InvalidValue.ExceedsMaximum	The size of the value cannot exceed 2,000,000 bytes.	The value deposited is too large.
403	InvalidKey.ExceedsCapacity	The maximum capacity of a single namespace cannot exceed 1 GB.	The capacity of the storage space exceeds the limit.
403	Unauthorized.InvalidParameters	The specified authentication parameters are invalid.	Authentication parameter input error.
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.
404	InvalidAccount.NotFound	The specified account does not exist.	The specified account does not exist.
404	InvalidNameSpace.NotFound	The specified namespace does not exist.	-
404	InvalidKey.NotFound	The specified key does not exist.	The specified key-value pair does not exist.
406	InvalidNameSpace.Duplicate	The specified namespace already exists.	Specified storage space
406	InvalidNameSpace.QuotaFull	The maximum number of namespaces is exceeded.	The number of storage spaces exceeds the capacity limit.
429	TooManyRequests	Too many requests are submitted.	Submissions are too frequent, please try again later
429	TooQuickRequests	Request for putting or deleting keys are frequently submitted.	The modification or deletion of key-value pairs is too frequent.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-20	The Error code has changed	View Change Details