Last updated: 2019-09-09 20:17:29

1. API Description

Domain name for API request:

This API (ModifySnapshotAttribute) is used to modify the attributes of a specified snapshot.

  • Currently, you can only modify snapshot name and change non-permanent snapshots into permanent snapshots.
  • "Snapshot name" is a custom name set by the user for easier management. Tencent Cloud does not use this name for ticket submission or snapshot management.

Default request rate limit: 20/sec.

Note: This API supports finance AZs. As finance AZs and non-finance AZs are isolated, when accessing the services in a finance AZ (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name with the finance AZ, preferably in the same region as specified in Region.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. Value used in this API: ModifySnapshotAttribute
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, see List of Regions supported by the product.
SnapshotId Yes String Snapshot ID, which can be queried via DescribeSnapshots.
SnapshotName No String New snapshot name with a maximum of 60 characters.
IsPermanent No Boolean The retention time of the snapshot. FALSE: non-permanent retention; TRUE: permanent retention. You can only modify non-permanent snapshots to permanent snapshots.

3. Output Parameters

Parameter Name Type Description
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Modifying a Snapshot Name

Input Sample Code
&<Common request parameters>

Output Sample Code

  "Response": {
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"

5. Resources for Developers

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 comes with SDKs that support multiple programming languages and make it easier to call the APIs.

Command line tools

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue Invalid parameter value. Parameter value is in an incorrect format or is not supported.
InvalidSnapshot.NotSupported This operation is not supported for the snapshot.
InvalidSnapshotId.NotFound The SnapshotId does not exist.
MissingParameter Missing parameter. A required parameter is missing in the request.