tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifySnapshotAttribute

Last updated: 2023-03-16 16:17:24

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

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 only used by users for their management. Tencent Cloud does not use the name as the basis for ticket submission or snapshot management.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 No String Common Params. This parameter is not required for this API.
SnapshotId Yes String Snapshot ID, which can be queried via DescribeSnapshots.
SnapshotName No String Name of new snapshot. Maximum length is 60 bytes.
IsPermanent No Boolean Snapshot retention mode. Valid values: FALSE: non-permanent retention; TRUE: permanent retention.
Deadline No Timestamp ISO8601 Expiration time of the snapshot. Setting this parameter will set the snapshot retention mode to FALSE (non-permanent retention) and the snapshot will be automatically deleted upon expiration.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Renaming a snapshot

This example shows you how to rename a cloud disk.

Input Example

https://cbs.tencentcloudapi.com/?Action=ModifySnapshotAttribute
&SnapshotId=snap-gybrif0z
&SnapshotName=snap_201711301143
&<Common Request Parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy