ListKVCacheStoreAttachInfo - KVCacheStore - Alibaba Cloud Documentation Center

Queries mount information of KVCacheInstances in batches.

Operation description

This operation has no KVCacheStore status restrictions. If a KVCacheStore is in the Creating state, an empty list is returned.
A KVCacheStore can be mounted to multiple VSCs. Each KVCacheStore may return multiple mount records.
This operation supports batch queries. You can query up to 100 KVCacheStores at a time.
This operation supports page number-based pagination (PageNumber and PageSize) and cursor-based pagination (NextToken and MaxResults). If both sets of pagination parameters are specified, cursor-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:ListKVCacheStoreAttachInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID, such as cn-hangzhou.	cn-hangzhou
KvcsIds	array	Yes	The list of KVCacheStore KvcsIds to query. You can specify up to 100 KvcsIds.
	string	No	The instance ID of the KVCacheStore resource.	kvcs-87djda131
MaxResults	integer	No	The maximum number of entries to return per query. Valid values: 1 to 500. Default value: 10.	20
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous call. You do not need to set this parameter for the first request. If NextToken is specified, the PageSize and PageNumber request parameters become invalid, and the TotalCount value in the response is invalid.	your-client-token
PageNumber	integer	No	The page number for paging queries. Used together with PageSize. If the specified page number exceeds the total number of pages, the last page of data is returned.	6
PageSize	integer	No	The number of entries per page for paging queries.	20

Response elements

Element	Type	Description	Example
	object	ListKvCacheStoreAttachInfoResponse
AttachInfos	array<object>	The list of mount information.
	object
AttachedAt	string	The time of the most recent attach operation in ISO 8601 format. This value is null if the instance is not attached.	2026-06-20T08:30:00Z
Capacity	integer	The file system capacity in GiB.	100
KvcsId	string	KVCacheStore KvcsId	kvcs-xxxxx
MountPointId	string	The file system-level mount point ID.	mp-xxxxx
RegionId	string	The region where the instance is deployed.	cn-hangzhou
Status	string	The attach status. Valid values: Attaching: The instance is being attached. Attached: The instance is attached. Detaching: The instance is being detached. After detachment is complete, the record is deleted and not returned.	Attached
Type	string	The instance type. Valid values: kvcs: KVCacheStore (CPFS).	preview
VscId	string	The VSC ID on the compute side.	vsc-001
ZoneId	string	The zone where the instance is deployed.	cn-hangzhou-a
NextToken	string	The pagination token. Use this token to query the next batch of data.	AAAAARbaCuN6hiD08qrLdwJ9Fh3NUkN7qf+fcWj7joK8M6tU
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
RequestId	string	The request ID. A request ID is returned regardless of whether the call is successful.	B127704C-ECB1-5B0A-AA9C-8F394A6F179F
TotalCount	integer	The total number of entries returned for a paging query.	2

Examples

Success response

JSON format

{
  "AttachInfos": [
    {
      "AttachedAt": "2026-06-20T08:30:00Z",
      "Capacity": 100,
      "KvcsId": "kvcs-xxxxx",
      "MountPointId": "mp-xxxxx",
      "RegionId": "cn-hangzhou",
      "Status": "Attached",
      "Type": "preview",
      "VscId": "vsc-001",
      "ZoneId": "cn-hangzhou-a"
    }
  ],
  "NextToken": "AAAAARbaCuN6hiD08qrLdwJ9Fh3NUkN7qf+fcWj7joK8M6tU",
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "B127704C-ECB1-5B0A-AA9C-8F394A6F179F",
  "TotalCount": 2
}

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	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
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.