ListKVCacheStoreAvailableVscs - KVCacheStore - Alibaba Cloud Documentation Center

Queries the list of available VSC resources associated with a specified KVCacheStore instance.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
KvcsId	string	Yes	The region ID, such as cn-hangzhou.	cn-hangzhou
InstanceId	string	Yes	The KVCacheStore instance ID.	kvcs-cn-5y44vuqiz001
InstanceType	string	Yes	The compute instance ID.	i-55kl5wq6j6kvtl4xu5tgunddu
RegionId	string	Yes	The compute instance type. Valid values: ECS EFLO	ECS
Arns	array<object>	No	The cross-account authorization role chain, used for cross-account VSC queries in ECS or EFLO scenarios.
	object	No
AssumeRoleFor	string	Yes	The target UID for role assumption.	1193522024229156
RoleArn	string	Yes	The ARN of the RAM role.	acs:ram::1028257687084022:role/zeus-locationservicerole
RoleType	string	Yes	The role type. Valid values: service user	service

Response elements

Element	Type	Description	Example
	object	ListKvCacheStoreAvailableVscsResponse
RequestId	string	The request ID.	request-id-xxx
Vscs	array<object>	The list of available VSC resources.
	object
VscId	string	The VSC device ID.	vsc-xxxxx
VscStatus	string	The current status of the VSC device.	Available

Examples

Success response

JSON format

{
  "RequestId": "request-id-xxx",
  "Vscs": [
    {
      "VscId": "vsc-xxxxx",
      "VscStatus": "Available"
    }
  ]
}

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	CrossAccountFeatureDisabled	Cross-account attach feature is not enabled.
400	InvalidArnChain	Invalid ARN chain: %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
500	VcsApiTimeout	VCS API call timed out.
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.
403	CrossAccountVerifyFailed	Cross-account VSC resource verification failed: %s
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	VcsResourceNotFound	VSC resource %s not found in target account.
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.