tencent cloud

Cloud Block Storage

User Guide
Announcements
Announcement of the Commercial Charges of Tencent Cloud CBS Snapshot
Announcement of the Commercial Charges of Tencent Cloud CBS Snapshot Cross-Region Replication
Product Introduction
Overview
Strengths
Scenarios
Regions and AZs
Cloud Disk Instances
Cloud Disk Snapshots
Access Management
Related Products
Predecessor
Service Regions and Service Providers
Billing
Billing Overview
Price Overview
Purchase Instructions
Renewal Guide
Overdue Payment
Getting Started
Step 1. Creating Cloud Disks
Step 2. Attaching Cloud Disks
Step 3. Initializing Cloud Disks
User Guide
Operation Overview
Usage Limits
Creating Cloud Disks
Attaching Cloud Disks
Initializing Cloud Disks
Expanding Cloud Disks
Detaching Cloud Disks
Terminating Cloud Disks
Viewing Cloud Disk Information
Adjusting Cloud Disk Types
Adjusting Cloud Disk Performance
Cloud Disk Data Protection Configuration
Cloud Disk Data Backup Point
Managing Snapshots
Monitoring and Alarms
Use Cases
Measuring Cloud Disk Performance
Building LVM Logic Volumes with Multiple Elastic Cloud Disks
Expanding MBR Cloud Disks to Greater Than 2 TB
Troubleshooting
Failed to Unmount Cloud Disks from Windows CVM Instances
Disk Not Mount upon Linux CVM Restart
API Documentation
History
Introduction
API Category
Making API Requests
Snapshot APIs
Cloud Disk APIs
Data Types
Error Codes
FAQs
Features
Billing
Performance FAQs
Snapshot
Usage
Cross-region Replication
CBS Service Level Agreement
Contact Us
Glossary
ドキュメントCloud Block StorageAPI DocumentationSnapshot APIsModifyAutoSnapshotPolicyAttribute

ModifyAutoSnapshotPolicyAttribute

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-30 21:30:48

1. API Description

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

This API (ModifyAutoSnapshotPolicyAttribute) is used to modify the attributes of an automatic snapshot policy.

  • You can use this API to modify the attributes of a scheduled snapshot policy, including the execution policy, name, and activation.
  • When modifying the number of days for retention, you must ensure that there is no clash with the permanent retention attribute. Otherwise, the entire operation will fail and a specific error code will be returned.

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: ModifyAutoSnapshotPolicyAttribute.
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.
AutoSnapshotPolicyId Yes String Scheduled snapshot policy ID.
IsActivated No Boolean Whether or not the scheduled snapshot policy is activated. FALSE: Not activated. TRUE: Activated. The default value is TRUE.
IsPermanent No Boolean Whether the snapshot created by this scheduled snapshot policy is retained permanently. FALSE: Not retained permanently. TRUE: Retained permanently. The default value is FALSE.
AutoSnapshotPolicyName No String The name of the scheduled snapshot policy to be created. If it is left empty, the default is 'Not named'. The maximum length cannot exceed 60 bytes.
Policy.N No Array of Policy The policy for executing the scheduled snapshot.
RetentionDays No Integer Number of days to retain the snapshots created according to this scheduled snapshot policy. If this parameter is specified, IsPermanent cannot be specified as TRUE; otherwise, they will conflict with each other.

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 Modifying the attributes of a scheduled snapshot policy

This example shows you how to rename a scheduled snapshot policy to data_disk_auto_snapshot and set the IsPermanent parameter to TRUE to permanently retain the snapshots created according to the scheduled snapshot policy.

Input Example

POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoSnapshotPolicyAttribute
<Common request parameters>

{
    "AutoSnapshotPolicyId": "asp-nqu08k2l",
    "AutoSnapshotPolicyName": "data_disk_auto_snapshot",
    "IsPermanent": "TRUE"
}

Output Example

{
    "Response": {
        "RequestId": "384c1fa8-6973-9623-b6bf-5a1fa9a7ad88"
    }
}

Example2 Enabling automatic snapshot policies

This example shows you how to enable automatic snapshot policies.

Input Example

POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoSnapshotPolicyAttribute
<Common request parameters>

{
    "AutoSnapshotPolicyId": "asp-01928374",
    "IsActivated": "true"
}

Output Example

{
    "Response": {
        "RequestId": "88a4815c-4a09-4948-b0c9-fa6fdefe8e4a"
    }
}

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
InvalidAccount.InsufficientBalance Insufficient account balance
InvalidAutoSnapshotPolicyId.NotFound AutoSnapshotPolicyId entered does not exist.
InvalidParameter Incorrect parameter.
MissingParameter Missing parameter.
UnsupportedOperation.StateError The resource does not support this operation in this status.
前の記事へ: DescribeSnapshots次の記事へ: ModifySnapshotsSharePermission

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック