CreateKVCacheStore - KVCacheStore - Alibaba Cloud Documentation Center

Creates a KVCacheInstance instance.

Operation description

This is an asynchronous operation. After the request is successful, the KVCacheStore enters the Creating state. You can call GetKVCacheStore or ListKVCacheStores to query the KVCacheStore status. The KVCacheStore is available after the status changes to Available.
To ensure idempotency in case of network exceptions, use ClientToken. If you call this operation with the same ClientToken and the same request parameters, the same KVCacheStore ID and order ID are returned. If the request parameters change, an IdempotentParameterMismatch error is returned.
When a KVCacheStore is created, an order is generated at the same time. The OrderId is returned in the response. You can view the order in the Expenses and Costs console. For more information, see View and manage orders.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID in which to create the KVCacheStore. You can call DescribeRegions to query the list of available regions.	cn-hangzhou
ZoneId	string	Yes	The zone ID. You can call DescribeZones to query the list of zones in the specified region.	cn-hangzhou-b
Name	string	No	The KVCacheStore name. The name must be 2 to 128 characters in length and can contain characters from the Unicode letter category (including English and Chinese characters) and digits. The name can contain colons (:), underscores (_), periods (.), and hyphens (-). If this parameter is not specified, the default value is the KVCacheStore ID.	sc-data-warehouse-server
Capacity	integer	Yes	The storage capacity in GiB. The minimum capacity is 300 TiB (307200 GiB), and the capacity is scaled out in increments of 300 TiB.	2395
HpnZone	string	Yes	The HPN cluster ID, which is used to create an affinity scheduling relationship between the KVCacheStore and the specified HPN cluster. After creation, the KVCacheStore may have affinity relationships with multiple HPN clusters based on network topology. You can call GetKVCacheStore to query the available HPN clusters.	B6
Description	string	No	The KVCacheStore description. The description must be 2 to 256 characters in length and can contain English and Chinese characters. The description cannot start with http:// or https://. Default value: empty.	No description
PaymentType	string	No	The billing method. Valid values: POSTPAY (pay-as-you-go). Default value: POSTPAY.	POSTPAY
Tag	array<object>	No	The list of resource tag key-value pairs. A maximum of 20 tags are supported. This overrides the parent TagDTO type and uses the same Tag type as returned by Get/List operations.
	object	No
TagKey	string	No	The tag key of the resource.	000098da1005a3df
TagValue	string	No	The tag value of the resource.	000088aabb0023f7
ResourceGroupId	string	No	The resource group ID.	rg-aekzafsjd7i4qaq
ClientToken	string	No	The client token that is used to ensure the idempotency of the request. The token can be up to 64 characters in length. We recommend that you use a UUID.	YOUR_CLIENT_TOKEN

Response elements

Element	Type	Description	Example
	object	CreateKvCacheStoreResponse
KvcsId	string	The ID of the newly created KVCacheStore.	kvs-xxxxx
OrderId	string	The order ID generated by this creation request.	order-xxxxx
RequestId	string	The request ID.	API-a6e81d15-1b36-4d37-ad61-593531e7fa58

Examples

Success response

JSON format

{
  "KvcsId": "kvs-xxxxx",
  "OrderId": "order-xxxxx",
  "RequestId": "API-a6e81d15-1b36-4d37-ad61-593531e7fa58"
}

Error codes

HTTP status code	Error code	Error message	Description
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	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.