DetachKVCacheStore - KVCacheStore - Alibaba Cloud Documentation Center

Unmounts KVCacheInstance resources from the virtualization side in batches.

Operation description

This is an asynchronous operation. A return status of Detaching indicates that the request has been accepted. Call ListKVCacheStoreAttachInfo to query mount records. When no record corresponding to the specified KvcsId and VscId is found, the unmount operation is complete.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID, such as cn-hangzhou.	cn-hangzhou
ResourceIds	array<object>	Yes	The list of resources to unmount. A maximum of 100 resources can be specified.
	object	No
KvcsId	string	Yes	KVCacheStore KvcsId	kvcs-your-resource-id
VscId	string	Yes	The VSC ID on the compute side.	vsc-uf6cpove22nrjnpenwkyal
ClientToken	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	DetachKvCacheStoreResponse
DetachResults	array<object>	The list of unmount results.
	object
KvcsId	string	KVCacheStore KvcsId	kvcs-xxxxx
VscId	string	The VSC ID on the compute side.	vsc-001
Status	string	The operation result. Valid values: DETACHING: The request has been accepted and the asynchronous unmount is in progress. This value is also returned for idempotent calls. Success: The synchronous validation passed and the asynchronous operation completed. Failed: The operation failed.	DETACHING
ErrorCode	string	The error code when the operation fails. This value is null when the operation succeeds.	KVCacheInstance.NotAttached
ErrorMessage	string	The error message when the operation fails. This value is null when the operation succeeds.	The KVCacheInstance is not in ATTACHED status.
RequestId	string	The request ID. A request ID is returned regardless of whether the API call succeeds.	B127704C-ECB1-5B0A-AA9C-8F394A6F179F

Examples

Success response

JSON format

{
  "DetachResults": [
    {
      "KvcsId": "kvcs-xxxxx",
      "VscId": "vsc-001",
      "Status": "DETACHING",
      "ErrorCode": "KVCacheInstance.NotAttached",
      "ErrorMessage": "The KVCacheInstance is not in ATTACHED status."
    }
  ],
  "RequestId": "B127704C-ECB1-5B0A-AA9C-8F394A6F179F"
}

Error codes

HTTP status code	Error code	Error message
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.
403	LastTokenProcessing	The last token request is processing.
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.