Edge KV Account Usage & Namespace Quota Overview - Edge Security Acceleration

Retrieves usage information for an account in the KV service, including a list of all namespaces.

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

No parameters required.

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the account. online: The account is active. offline: The account is shut down.	online
RequestId	string	The request ID.	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
NamespaceUsed	integer	The number of namespaces created for the account.	1
NamespaceQuota	integer	The quota on the number of KV storage spaces that you can request for the account.	10
CapacityString	string	The total available capacity of all namespaces for the account.	1 GB
CapacityUsedString	string	The total used capacity of all namespaces for the account.	100 MB
Capacity	integer	The total available capacity of all namespaces for the account, in bytes.	1073741824
CapacityUsed	integer	The total used capacity of all namespaces for the account, in bytes.	10048576
NamespaceList	array<object>	The list of namespaces for the account.
	object
Status	string	The status of the namespace. Valid values: online: Normal. delete: Pending deletion. deleting: Being deleted. deleted: Deleted.	online
Namespace	string	The name of the namespace.	test_namespace
NamespaceId	string	The ID of the namespace.	643355322374688768
Description	string	The description of the namespace.	the first namespace
Capacity	integer	The available capacity of the namespace, in bytes.	1073741824
CapacityUsed	integer	The used capacity of the namespace, in bytes.	100048576
CapacityString	string	The available capacity of the namespace.	1 GB
CapacityUsedString	string	The used capacity of the namespace.	100 MB

Examples

Success response

JSON format

{
  "Status": "online",
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "NamespaceUsed": 1,
  "NamespaceQuota": 10,
  "CapacityString": "1 GB",
  "CapacityUsedString": "100 MB",
  "Capacity": 1073741824,
  "CapacityUsed": 10048576,
  "NamespaceList": [
    {
      "Status": "online",
      "Namespace": "test_namespace",
      "NamespaceId": "643355322374688768",
      "Description": "the first namespace",
      "Capacity": 1073741824,
      "CapacityUsed": 100048576,
      "CapacityString": "1 GB",
      "CapacityUsedString": "100 MB"
    }
  ]
}

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.