Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to modify the attributes of a specified snapshot.
This API supports modifying snapshot name and expiration time, as well as changing a non-permanent snapshot to a permanent one.
The "snapshot name" is only for making user management convenient. Tencent Cloud does not use this name as a basis for submitting tickets or managing snapshot operations.
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: ModifySnapshotAttribute. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SnapshotId | Yes | String | Snapshot ID. can be queried via DescribeSnapshots (https://www.tencentcloud.com/document/api/362/15647?from_cn_redirect=1). |
| IsPermanent | No | Boolean | Snapshot retention mode. Valid values: FALSE: non-permanent retention; TRUE: permanent retention. |
| SnapshotName | No | String | Name of new snapshot. Maximum length is 60 bytes. |
| Deadline | No | Timestamp ISO8601 | Specifies the snapshot expiration time. the snapshot will be simultaneously set to the non-permanent retention method. snapshots exceeding the expiry time will be automatically deleted. note: this parameter is valid only when IsPermanent is False. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
This example shows you how to rename a cloud disk.
https://cbs.intl.tencentcloudapi.com/?Action=ModifySnapshotAttribute
&SnapshotId=snap-gybrif0z
&SnapshotName=snap_201711301143
&<Common Request Parameters>
{
"Response": {
"RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
}
}
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 |
|---|---|
| InvalidParameterValue | Invalid parameter value. |
| InvalidSnapshot.NotSupported | Indicates that the operation is not supported for the snapshot. |
| InvalidSnapshotId.NotFound | The ‘SnapshotId’ entered does not exist. |
| MissingParameter | Missing parameter. |
| UnsupportedOperation.SnapHasShared | The snapshot is shared with others. Please cancel the sharing first. |
| UnsupportedOperation.SnapshotHasBindedImage | A custom snapshot was created for this snapshot. First delete the corresponding image. |
文档反馈