DescribeDcdnKvNamespace - Edge Security Acceleration - Alibaba Cloud Documentation Center

Describes a 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnKvNamespace

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the namespace. Valid values: online: Normal. delete: Pending deletion. deleting: Deleting. deleted: Deleted.	online
Namespace	string	The namespace name.	ns1
NamespaceId	string	The namespace ID.	12423131231****
RequestId	string	The request ID.	D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C
Description	string	The namespace description.	the first namespace
CapacityString	string	The available capacity of the namespace.	1 GB
CapacityUsedString	string	The used capacity of the namespace.	100 MB
Mode	string	The mode. Normal mode: The default mode. If a key-value (KV) pair is not found on an edge node, the node queries the central data center for the KV pair to ensure global data consistency. Rapid mode: If a KV pair is not found on an edge node, the node returns a "key not found" message without querying the central data center. This mode improves KV query performance but may reduce the KV query hit rate. To enable this mode, submit a ticket.	Normal
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": "ns1",
  "NamespaceId": "12423131231****",
  "RequestId": "D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C",
  "Description": "the first namespace",
  "CapacityString": "1 GB",
  "CapacityUsedString": "100 MB",
  "Mode": "Normal",
  "Capacity": 1073741824,
  "CapacityUsed": 10048576
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.