ListKVCacheStoreAvailableHpnZones - KVCacheStore - Alibaba Cloud Documentation Center

Queries the list of available HpnZones for a specified KVCacheStore instance.

Operation description

This operation queries available HpnZones by KVCacheStore. Use this operation to query available HPN cluster IDs before scaling or migrating a KVCacheStore.

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

none

*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 instance IDs, separated by commas. You can specify a minimum of 1 and a maximum of 100 instance IDs.
	string	No	The KVCacheStore instance ID.	kvcs-87djda131

Response elements

Element	Type	Description	Example
	object	ListKvCacheStoreAvailableHpnZonesResponse
InstanceHpnZones	array<object>	The list of available HpnZone information for instances.
	array<object>
KvcsId	string	The KVCacheStore instance ID.	kvcs-xxxxx
ZoneId	string	The zone ID of the instance.	cn-hangzhou-a
AvailableHpnZones	array<object>	The list of available HpnZones for the instance.
	object
HpnZone	string	The cluster ID, such as default.	default
RequestId	string	The request ID. A request ID is returned regardless of whether the call is successful.	019FB5E9-F9E8-52F5-9C56-2CDF479CBEB2

Examples

Success response

JSON format

{
  "InstanceHpnZones": [
    {
      "KvcsId": "kvcs-xxxxx",
      "ZoneId": "cn-hangzhou-a",
      "AvailableHpnZones": [
        {
          "HpnZone": "default"
        }
      ]
    }
  ],
  "RequestId": "019FB5E9-F9E8-52F5-9C56-2CDF479CBEB2"
}

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.
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.
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.