ListKVCacheStores - KVCacheStore - Alibaba Cloud Documentation Center

Queries a list of KVCacheInstance instances.

Operation description

Two pagination methods are supported: page number-based pagination (PageNumber + PageSize) and cursor-based pagination (NextToken + MaxResults). If both are specified, page number-based pagination takes precedence.

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

kvcachestore:ListKVCacheStores

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID, such as cn-hangzhou.	cn-hangzhou
ZoneId	string	No	The zone ID, such as cn-hangzhou-a.	cn-hangzhou-k
Name	string	No	The instance name used for filtering. Prefix matching is supported.	obj-detect
KvcsIds	string	No	The list of KvcsId values. Separate multiple IDs with commas (,). A maximum of 100 IDs can be specified.	kvcs-87djda131
Status	string	No	The instance status used for filtering. Valid values: Creating, Available, InUse, Stopping, Stopped, and Deleting.	Available
PageNumber	integer	No	The page number. Default value: 1. This parameter and NextToken are mutually exclusive. If both are specified, PageNumber takes precedence.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100. This parameter is used together with PageNumber.	10
NextToken	string	No	The pagination token. Do not specify this parameter for the first request. For subsequent requests, use the NextToken value returned in the previous response. This parameter and PageNumber are mutually exclusive.	a24c3a9cc8e6da77b10cffc4c93c7922e0b5e8707e68181f
MaxResults	integer	No	The maximum number of entries per page for cursor-based pagination. Default value: 10. Maximum value: 100. This parameter is used together with NextToken.	10

Response elements

Element	Type	Description	Example
	object	DescribeKvCacheStoreResponse
KVCacheStores	array<object>	The list of KVCacheStore instances. Each element contains the following parameters: KvcsId, Name, Status, ExtraStatus, RegionId, ZoneId, HpnZone, Type, Capacity, PaymentType, MountPointId, CreateTime, and Description.
	array<object>
Capacity	integer	The storage capacity, in GiB.	100
CreateTime	string	The creation time in ISO 8601 format.	2026-06-18T10:00:00Z
Description	string	The instance description.	production kvcachestore
ExtraStatus	string	The extra status information. Valid values: CapacityExpanding, CapacityExpandSuccess, and CapacityExpandFail.	CapacityExpanding
HpnZone	string	The cluster ID.	default
KvcsId	string	The instance ID.	kvcs-xxxxx
MountPointId	string	The file system-level mount point ID. Instances under the same file system share this mount point. For more information, use the ListKVCacheInstanceAttachInfo operation.	mp-xxxxx
Name	string	The instance name.	production-instance
PaymentType	string	The payment type. Valid values: PREPAY and POSTPAY.	POSTPAY
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The resource group ID.	rg-aek3dnrvdxj2dvq
Status	string	The instance status. Valid values: Creating, Available, InUse, Stopping, Stopped, and Deleting.	AVAILABLE
Tags	array<object>	The list of resource tags.
	object
TagKey	string	The tag key of the resource.	chapter
TagValue	string	The tag value of the resource.	test-value-1766542011
Type	string	The instance type. Valid values: kvcs (KVCacheStore, CPFS).	preview
ZoneId	string	The zone ID.	cn-hangzhou-a
MaxResults	integer	The maximum number of entries returned per page.	10
NextToken	string	The pagination token for the next page. This value is empty when no more data is available. This parameter is valid only for cursor-based pagination.	caeba0bbb2be03f84eb48b699f0a4883
PageNumber	integer	The current page number. This parameter is valid only for page number-based pagination.	1
PageSize	integer	The number of entries per page. This parameter is valid only for page number-based pagination.	10
PageTotal	integer	The total number of pages. This parameter is returned only for page number-based pagination.	1
RequestId	string	The request ID. A request ID is returned regardless of whether the call is successful.	56AC37CD-388E-5D21-951B-C50D16D8E812
TotalCount	integer	The total number of instances. This parameter is returned only for page number-based pagination. For cursor-based pagination, the value is -1.	10

Examples

Success response

JSON format

{
  "KVCacheStores": [
    {
      "Capacity": 100,
      "CreateTime": "2026-06-18T10:00:00Z",
      "Description": "production kvcachestore",
      "ExtraStatus": "CapacityExpanding",
      "HpnZone": "default",
      "KvcsId": "kvcs-xxxxx",
      "MountPointId": "mp-xxxxx",
      "Name": "production-instance",
      "PaymentType": "POSTPAY",
      "RegionId": "cn-hangzhou",
      "ResourceGroupId": "rg-aek3dnrvdxj2dvq",
      "Status": "AVAILABLE",
      "Tags": [
        {
          "TagKey": "chapter",
          "TagValue": "test-value-1766542011"
        }
      ],
      "Type": "preview",
      "ZoneId": "cn-hangzhou-a"
    }
  ],
  "MaxResults": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageNumber": 1,
  "PageSize": 10,
  "PageTotal": 1,
  "RequestId": "56AC37CD-388E-5D21-951B-C50D16D8E812",
  "TotalCount": 10
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	Your account balance is insufficient.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist
504	RequestTimeout	The request is timeout, please try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.