DescribeDcdnKvNamespace - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the information about a namespace.

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
dcdn:DescribeDcdnKvNamespace	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The name of the namespace.	ns1

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the namespace. Valid values: online: normal delete: pending delete deleting: being deleted deleted: deleted	online
Namespace	string	The name of the namespace.	ns1
NamespaceId	string	The ID of the namespace.	12423131231****
RequestId	string	The ID of the request.	D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C
Description	string	The description of the namespace.	the first namespace
CapacityString	string	The available capacity of all namespaces in your account.	1 GB
CapacityUsedString	string	The used capacity of all namespaces in your account.	100 MB
Mode	string	The system behavior when a key-value pair fails to be obtained at the edge. Valid values: Normal (default): If a key-value pair fails to be obtained at the edge, DCDN attempts to query the key-value pair from the origin server to ensure global data consistency. Rapid: If a key-value pair fails to be obtained at the edge, an error message indicating that the key does not exist is returned. This feature enhances key-value query performance but may decrease the hit rate of queries. To enable this feature, submit a ticket.	Normal

Examples

Sample success responses

JSONformat

{
  "Status": "online",
  "Namespace": "ns1",
  "NamespaceId": "12423131231****",
  "RequestId": "D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C",
  "Description": "the first namespace",
  "CapacityString": "1 GB",
  "CapacityUsedString": "100 MB",
  "Mode": "Normal"
}

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
2024-08-20	The Error code has changed. The response structure of the API has changed	View Change Details
2024-03-21	The Error code has changed. The response structure of the API has changed	View Change Details