GetKvNamespace - Query KV namespace | ESA API - Edge Security Acceleration

Retrieves information about a specific KV 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 namespace name, as specified when calling CreateKvNamespace.	test_namespace

Response elements

Element	Type	Description	Example
	object	The response parameters.
Status	string	The status of the namespace. Valid values: online: The namespace is active. delete: The namespace is marked for deletion. deleting: The namespace is being deleted. deleted: The namespace has been deleted.	online
Namespace	string	The name of the namespace.	test_namespace
NamespaceId	string	The ID of the namespace.	643355322374688768
RequestId	string	The ID of the request.	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
Description	string	The description of the namespace.	this is a test namespace.
CapacityString	string	The available capacity of the namespace in human-readable format.	1 GB
CapacityUsedString	string	The used capacity of the namespace in human-readable format.	100 MB
Capacity	integer	The available capacity of the namespace, in bytes.	1073741824
CapacityUsed	integer	The used capacity of the namespace, in bytes.	10048576

Examples

Success response

JSON format

{
  "Status": "online",
  "Namespace": "test_namespace",
  "NamespaceId": "643355322374688768",
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "Description": "this is a test namespace.",
  "CapacityString": "1 GB",
  "CapacityUsedString": "100 MB",
  "Capacity": 1073741824,
  "CapacityUsed": 10048576
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccount.Malformed	The specified account is invalid.	The specified account is malformed. For example, the value is empty.
400	InvalidNameSpace.Malformed	The specified namespace is invalid.	The specified namespace is malformed. For example, the value is empty.
400	InvalidKey.Malformed	The specified key is invalid.	The specified key is malformed. For example, the value is empty.
400	InvalidKey.ExceedsMaximum	The size of the key cannot exceed 512 bytes.	The specified key exceeds the maximum size of 512 bytes.
400	InvalidValue.ExceedsMaximum	The size of the value cannot exceed 2,000,000 bytes.	The specified value exceeds the maximum size.
403	InvalidKey.ExceedsCapacity	The maximum capacity of a single namespace cannot exceed 1 GB.	The namespace capacity exceeds the 1 GB limit.
403	Unauthorized.InvalidParameters	The specified authentication parameters are invalid.	The specified authentication parameters are invalid.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The specified authentication time is invalid.
403	Unauthorized.InvalidToken	Token authentication failed.	The specified token 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.
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.	The specified namespace already exists.
406	InvalidNameSpace.QuotaFull	The maximum number of namespaces is exceeded.	The maximum number of namespaces has been reached.
429	TooManyRequests	Too many requests are submitted.	Too many requests. Try again later.
429	TooQuickRequests	Request for putting or deleting keys are frequently submitted.	Key put or delete requests are too frequent.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.