All Products
Search
Document Center

Edge Security Acceleration:GetKvAccount

Last Updated:Mar 24, 2025

Queries the Edge KV usage in your Alibaba Cloud account, including the information about all namespaces.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:GetKvAccountget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

Indicates whether Edge KV is activated for the Alibaba Cloud account.

  • online
  • offline
online
RequestIdstring

The request ID.

EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
NamespaceUsedinteger

The number of created namespaces that store key-value data in the account.

1
NamespaceQuotainteger

The maximum number of namespaces that can be created in the account.

10
CapacityStringstring

The available capacity of all namespaces in the account.

1 GB
CapacityUsedStringstring

The used capacity of all namespaces in the account.

100 MB
Capacitylong

The available capacity of all namespaces in the account. Unit: bytes.

1073741824
CapacityUsedlong

The used capacity of all namespaces in the account. Unit: bytes.

10048576
NamespaceListarray<object>

The namespaces in the account.

namespacesobject
Statusstring

The status of the namespace. Valid values:

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

The name of the namespace.

test_namespace
NamespaceIdstring

The ID of the namespace.

643355322374688768
Descriptionstring

The description of the namespace.

the first namespace
Capacitylong

The available capacity of the namespace. Unit: bytes.

1073741824
CapacityUsedlong

The used capacity of the namespace. Unit: bytes.

100048576
CapacityStringstring

The available capacity of the namespace.

1 GB
CapacityUsedStringstring

The used capacity of the namespace.

100 MB

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidAccount.MalformedThe specified account is invalid.The account number is not entered correctly, for example, the input is empty.
400InvalidNameSpace.MalformedThe specified namespace is invalid.The bucket name is entered incorrectly, such as an empty string.
400InvalidKey.MalformedThe specified key is invalid.Key name input error, such as entering an empty string.
400InvalidKey.ExceedsMaximumThe size of the key cannot exceed 512 bytes.The length of the requested key is too large.
400InvalidValue.ExceedsMaximumThe size of the value cannot exceed 2,000,000 bytes.The value deposited is too large.
403InvalidKey.ExceedsCapacityThe maximum capacity of a single namespace cannot exceed 1 GB.The capacity of the storage space exceeds the limit.
403Unauthorized.InvalidParametersThe specified authentication parameters are invalid.Authentication parameter input error.
403Unauthorized.InvalidTimeThe specified authentication time is invalid.The authentication time parameter you entered is invalid. Check the parameter value and try again.
403Unauthorized.InvalidTokenToken authentication failed.The token you entered is invalid. Please check and enter the correct token and try again.
404InvalidAccount.NotFoundThe specified account does not exist.The specified account does not exist.
404InvalidNameSpace.NotFoundThe specified namespace does not exist.-
404InvalidKey.NotFoundThe specified key does not exist.The specified key-value pair does not exist.
406InvalidNameSpace.DuplicateThe specified namespace already exists.Specified storage space
406InvalidNameSpace.QuotaFullThe maximum number of namespaces is exceeded.The number of storage spaces exceeds the capacity limit.
429TooManyRequestsToo many requests are submitted.Submissions are too frequent, please try again later
429TooQuickRequestsRequest for putting or deleting keys are frequently submitted.The modification or deletion of key-value pairs is too frequent.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history