Use ListKvs to Query Key-Value Pairs - Edge Security Acceleration

Lists all key-value pairs in a specified namespace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The name that you specified when you called CreatevNamespace.	test_namespace
PageSize	integer	No	The number of entries to return on each page. Default: 50. Maximum: 100.	50
PageNumber	integer	No	The page number to return. The value of PageNumber * PageSize cannot exceed 50,000.	10
Prefix	string	No	The prefix of the keys to return.	prefix-

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageSize	integer	The number of records on each page.	50
PageNumber	integer	The total number of pages.	100
TotalCount	integer	The total number of records.	1024
Keys	array<object>	The list of key-value pairs returned by this traversal.
	object
Name	string	The name of the key.	Key1
UpdateTime	string	The time when the key was last updated.	2021-12-13T07:46:03Z

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "PageSize": 50,
  "PageNumber": 100,
  "TotalCount": 1024,
  "Keys": [
    {
      "Name": "Key1",
      "UpdateTime": "2021-12-13T07:46:03Z"
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.