Domain name for API request: cynosdb.intl.tencentcloudapi.com.
Modify the configuration of a backup safe, including the name, description, retention duration, encryption key, and lock time.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyVault. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| VaultId | Yes | String | Safe ID |
| VaultName | No | String | Safe name. Maximum length: 255 characters. |
| VaultDescribe | No | String | Safe description. Maximum length: 1024 characters. |
| BackupSaveSeconds | No | Integer | Backup retention period in seconds. Value range: (0, 632448000] |
| KeyId | No | String | Encryption key ID. Maximum length: 36 characters. |
| KeyType | No | String | Key type. Available values: cloud, custom |
| KeyRegion | No | String | Region of the key. Maximum length: 32 characters. |
| IsLock | No | Boolean | Whether the safe is locked |
| LockedTime | No | String | Lock expiration time. Format: 2006-01-02 15:04:05. The lock time can be up to 15 days from now. |
| IsEncryption | No | Boolean | Encrypted or not |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyVault
<Common request parameters>
{
"VaultId": "vault-bb80705c-e6cb-4e40-b9f6-93e540a50f61",
"BackupSaveSeconds": 600
}{
"Response": {
"TaskId": 4295126097,
"RequestId": "7968c0b3-88e6-4ad5-b8a0-cf5fde099627"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| OperationDenied.BackupVaultTaskConflictError | Backup safe resource {{1}} is in {{2}} and unable to perform {{3}} operation |
| UnauthorizedOperation.RoleUnauthorized | Authorization failed or authorization canceled. |
文档反馈