CreateColdStorageInstance
Creates a cold storage instance.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
polardb:CreateColdStorageInstance |
create |
*ColdStorageInstance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ResourceGroupId |
string |
No |
The resource group ID. |
rg-************ |
| DBClusterId |
string |
Yes |
The cluster ID. Note
You can call the DescribeDBClusters operation to view the details of all clusters under your account, such as the cluster ID. The cluster must be in the Running state before you call this operation. You can verify the state by checking the DBClusterStatus parameter returned by DescribeDBClusterAttribute. |
pc-wz9ye3xrtj60ua6d1 |
| ColdStorageInstanceDescription |
string |
No |
The description of the cold storage instance. The description can be up to 256 characters in length. |
Cold storage instance for archiving historical data |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is 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 cold storage instance ID. |
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.