All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnKvAccount

Last Updated:May 11, 2024

Queries the information about the key-value pairs that belong to your account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnKvAccountRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The status of the account.

  • online: enabled
  • offline: disabled
online,offline
RequestIdstring

The ID of the request.

D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C
NamespaceUsedinteger

The number of namespaces that you applied for by using your account.

1
NamespaceQuotainteger

The maximum number of namespaces that you can apply for by using your account.

10
CapacityStringstring

The available capacity of all namespaces.

2GB
CapacityUsedStringstring

All namespaces have used capacity.

200 MB
NamespaceListobject []

Details about the namespaces.

Statusstring

The status of the namespace. Valid values:

  • online: normal
  • delete: pending delete
  • deleting: being deleted
  • deleted: deleted
online
Namespacestring

The name of the namespace.

ns1
NamespaceIdstring

The ID of the namespace.

12423131231****
Descriptionstring

The description of the namespace.

the first namespace
CapacityStringstring

The available capacity of the namespace.

1 GB
CapacityUsedStringstring

The namespace has used capacity.

100 MB

Examples

Sample success responses

JSONformat

{
  "Status": "online,offline",
  "RequestId": "D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C",
  "NamespaceUsed": 1,
  "NamespaceQuota": 10,
  "CapacityString": "2GB",
  "CapacityUsedString": "200 MB",
  "NamespaceList": [
    {
      "Status": "online",
      "Namespace": "ns1",
      "NamespaceId": "12423131231****",
      "Description": "the first namespace",
      "CapacityString": "1 GB",
      "CapacityUsedString": "100 MB"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.ParameterThe specified parameter is invalid.The parameter is set to an invalid value.
400InvalidAccount.MalformedThe specified account is invalid.The account is invalid. Check whether an account is specified.
400InvalidNameSpace.MalformedThe specified namespace is invalid.The namespace is invalid. Check whether a namespace is specified.
400InvalidKey.MalformedThe specified key is invalid.The key is invalid. Check whether a key is specified.
400InvalidKey.ExceedsMaximumThe size of the key cannot exceed 512 bytes.The key cannot exceed 512 bytes in length.
400InvalidValue.ExceedsMaximumThe size of the value cannot exceed 2,000,000 bytes.The value cannot exceed 2,000,000 bytes in length.
403InvalidKey.ExceedsCapacityThe 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.
403Unauthorized.InvalidParametersThe specified authentication parameters are invalid.An authentication parameter is set to an invalid value.
403Unauthorized.InvalidTimeThe specified authentication time is invalid.The time parameter is set in an invalid format.
403Unauthorized.InvalidTokenToken authentication failed.The specified token is invalid.
403Unauthorized.InvalidResourceResource authentication failed.The specified resource is invalid.
404InvalidAccount.NotFoundThe specified account does not exist.The specified account does not exist.
404InvalidNameSpace.NotFoundThe specified namespace does not exist.The specified namespace does not exist.
404InvalidKey.NotFoundThe specified key does not exist.The specified key does not exist.
406InvalidNameSpace.DuplicateThe specified namespace already exists.The namespace already exists.
406InvalidNameSpace.QuotaFullThe maximum number of namespaces is exceeded.The number of namespaces has reached the upper limit.
406InvalidKey.QuotaFullThe maximum number of keys is exceeded.The number of keys has reached the upper limit.
429TooManyRequestsToo many requests are submitted.Do not send requests at a high frequency.
429TooQuickRequestsRequest 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 timeSummary of changesOperation
No change history