AttachKVCacheStore - KVCacheStore - Alibaba Cloud Documentation Center

Mounts KVCacheInstance resources to the virtualization side in batches.

Operation description

This is an asynchronous operation. A return status of Attaching indicates that the request has been accepted. Call ListKVCacheStoreAttachInfo to query mount records. A record status of Attached indicates that the mount is complete.
The KVCacheStore must be in the Available or InUse state before it can be mounted.

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:AttachKVCacheStore

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID, such as cn-hangzhou.	cn-hangzhou
ResourceIds	array<object>	Yes	The VSC instance type. Valid values: EFLO, ECS, and INNER_ECS. Default value: EFLO.	ECS
	object	No
KvcsId	string	Yes	KVCacheStore KvcsId	kvcs-your-resource-id
VscId	string	Yes	The VSC ID pre-created on the compute side.	vsc-uf6acaf6k6mt1ts95to6al
Arns	array<object>	No	The list of resources to mount. A maximum of 100 resources can be specified.
	object	No
AssumeRoleFor	string	No	The target UID for role assumption.	1193522024229156
RoleArn	string	Yes	The Alibaba Cloud Resource Name (ARN) of the RAM role.	acs:ram::1028257687084022:role/zeus-locationservicerole
RoleType	string	Yes	The role type. Valid values: service user	service
ClientToken	string	No	The cross-account authorization role chain used for cross-account VSC resource verification.	YOUR_CLIENT_TOKEN
InstanceType	string	No	A string generated by the server that serves as a unique identifier for the client request.	YOUR_CLIENT_TOKEN

Response elements

Element	Type	Description	Example
	object	AttachKvCacheStoreResponse
AttachResults	array<object>	The list of mount results.
	object
ErrorCode	string	The error code returned upon failure. This value is null upon success.	InvalidStatus.OperationDenied
ErrorMessage	string	The error message returned upon failure. This value is null upon success.	The operation is not allowed for instance in ATTACHED status.
KvcsId	string	KVCacheStore KvcsId	kvcs-xxxxx
Status	string	The operation result. Valid values: ATTACHING: The request has been accepted and the asynchronous mount is in progress. ATTACHED: Idempotent. The mount is already complete. Success: The synchronous verification passed and the asynchronous operation is complete. Failed: The operation failed.	ATTACHING
VscId	string	The VSC ID on the compute side.	vsc-001
RequestId	string	The request ID. A request ID is returned regardless of whether the call is successful.	F7BEF1E2-7E56-5BF1-8E36-77A51C5812F1

Examples

Success response

JSON format

{
  "AttachResults": [
    {
      "ErrorCode": "InvalidStatus.OperationDenied",
      "ErrorMessage": "The operation is not allowed for instance in ATTACHED status.",
      "KvcsId": "kvcs-xxxxx",
      "Status": "ATTACHING",
      "VscId": "vsc-001"
    }
  ],
  "RequestId": "F7BEF1E2-7E56-5BF1-8E36-77A51C5812F1"
}

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.
400	InvalidStatus.vsc	The VSC status does not support this operation. The VSC must be in 'Normal' status before attaching.	The VSC status does not support this operation. The VSC must be in 'Normal' status before attaching.
400	InvalidType.vsc	The VSC type does not support this operation. The VSC type must be 'primary'.	The VSC type does not support this operation. The VSC type must be 'primary '.
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.
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.