CreateColdStorageInstance - - Alibaba Cloud Documentation Center

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

polardb:CreateColdStorageInstance

create

*ColdStorageInstance

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group.	rg-************
DBClusterId	string	Yes	The cluster ID. Note Call the DescribeDBClusters operation to query the details of all clusters in your account, such as the cluster ID.	pc-wz9ye3xrtj60ua6d1
ColdStorageInstanceDescription	string	No	The description of the cold storage instance. The description can be up to 256 characters in length.	xxxxxxxxx
ClientToken	string	No	A client token to ensure the idempotence of a request. This token is generated by the client and must be unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.	6000170000591aed949d0f5********************

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2
ColdStorageInstanceId	string	The ID of the cold storage instance.	pcs_2zeth2gf4i83e578t

Examples

Success response

JSON format

{
  "RequestId": "F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2",
  "ColdStorageInstanceId": "pcs_2zeth2gf4i83e578t"
}

Error codes

HTTP status code	Error code	Error message	Description
400	LockTimeout	The request processing has failed due to lock timeout.	Failed to process the request due to a lock timeout.
400	EngineMigration.ActionDisabled	Specified action is disabled while custins is in engine migration.	The specified operation is disabled when custins is being migrated across engines.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.