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 APIsDescribeSnapshots

DescribeSnapshots

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

1. API Description

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

This API (DescribeSnapshots) is used to query the details of snapshots.

  • Filter the results by the snapshot ID, the ID of cloud disk, for which the snapshot is created, and the type of cloud disk, for which the snapshot is created. The relationship between different conditions is AND. For more information about filtering, please see Filter.
  • If the parameter is empty, a certain number (specified by Limit; the default is 20) of snapshot lists are returned to the current user.

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: DescribeSnapshots.
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.
SnapshotIds.N No Array of String List of snapshot IDs to be queried. The parameter does not support specifying both SnapshotIds and Filters.
Filters.N No Array of Filter Filters. It cannot be specified together with SnapshotIds.
  • snapshot-id - Array of String - Optional - Filters by snapshot ID, such as snap-11112222.
  • snapshot-name - Array of String - Optional - Filters by snapshot name.
  • snapshot-state - Array of String - Optional - Filters by snapshot state (NORMAL: normal | CREATING: creating | ROLLBACKING: rolling back).
  • disk-usage - Array of String - Optional - Filters by the type of the cloud disk from which a snapshot is created (SYSTEM_DISK: system disk | DATA_DISK: data disk).
  • project-id - Array of String - Optional - Filters by the ID of the project to which a cloud disk belongs.
  • disk-id - Array of String - Optional - Filters by the ID of the cloud disk from which a snapshot is created.
  • zone - Array of String - Optional - Filters by availability zone.
  • encrypt - Array of String - Optional - Filters by whether a snapshot is created from an encrypted cloud disk. (TRUE: a snapshot of an encrypted cloud disk | FALSE: not a snapshot of an encrypted cloud disk.)
  • snapshot-type- Array of String - Optional - Filters by the snapshot type specified in snapshot-type.
    (SHARED_SNAPSHOT: a shared snapshot | PRIVATE_SNAPSHOT: a private snapshot.)
    		•
    Offset No Integer Offset. Default is 0. For more information on Offset, please see relevant sections in API Introduction.
    Limit No Integer Number of results to be returned. Default is 20. Maximum is 100. For more information on Limit, please see relevant sections in API Introduction.
    Order No String Outputs the ordering of the cloud disk list. Value range:
  • ASC: Ascending order
  • DESC: Descending order.
    		•
    OrderField No String The field by which the snapshot list is sorted. Value range:
  • CREATE_TIME: sorted by the creation time of the snapshots
    By default, the snapshot list is sorted by the creation time of snapshots.
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of snapshots.
    SnapshotSet Array of Snapshot List of snapshot details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying snapshots in NORMAL status in Guangzhou Zone 2

    This example shows you how to query snapshots in NORMAL status in Guangzhou Zone 2.

    Input Example

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

{
    "Filters": [
        {
            "Name": "snapshot-state",
            "Values": [
                "NORMAL"
            ]
        },
        {
            "Name": "zone",
            "Values": [
                "ap-guangzhou-2"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 2,
        "RequestId": "7974489b-8d50-4bbd-8dd2-b700bb98b8cf",
        "SnapshotSet": [
            {
                "Tags": [],
                "Placement": {
                    "CageId": "",
                    "Zone": "ap-guangzhou-2",
                    "ProjectId": 0,
                    "CdcName": "",
                    "CdcId": "",
                    "ProjectName": "",
                    "DedicatedClusterId": ""
                },
                "CopyFromRemote": false,
                "IsPermanent": true,
                "DiskUsage": "DATA_DISK",
                "DeadlineTime": "2023-04-09 10:45:11",
                "Percent": 100,
                "SnapshotId": "snap-0jfkjwl1",
                "ShareReference": 0,
                "SnapshotType": "PRIVATE_SNAPSHOT",
                "DiskSize": 70,
                "DiskId": "disk-omp7wl2m",
                "SnapshotName": "TEST",
                "Images": [],
                "CopyingToRegions": [],
                "Encrypt": false,
                "CreateTime": "2023-03-09 10:45:11",
                "TimeStartShare": "2023-03-09",
                "ImageCount": 0,
                "SnapshotState": "NORMAL"
            },
            {
                "Tags": [],
                "Placement": {
                    "CageId": "",
                    "Zone": "ap-guangzhou-2",
                    "ProjectId": 0,
                    "CdcName": "",
                    "CdcId": "",
                    "ProjectName": "",
                    "DedicatedClusterId": ""
                },
                "CopyFromRemote": false,
                "IsPermanent": true,
                "DiskUsage": "SYSTEM_DISK",
                "DeadlineTime": "2023-04-09 10:45:11",
                "Percent": 100,
                "SnapshotId": "snap-obgelzpb",
                "ShareReference": 0,
                "SnapshotType": "PRIVATE_SNAPSHOT",
                "DiskSize": 50,
                "DiskId": "disk-1en5p0sq",
                "SnapshotName": "test-stevenkli",
                "Images": [],
                "CopyingToRegions": [],
                "Encrypt": false,
                "CreateTime": "2023-03-08 17:12:42",
                "ImageCount": 0,
                "TimeStartShare": "2023-03-09",
                "SnapshotState": "NORMAL"
            }
        ]
    }
}

    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
    InvalidFilter The specified Filter is not supported.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    UnsupportedOperation Unsupported operation
    前の記事へ: DescribeSnapshotSharePermission次の記事へ: ModifyAutoSnapshotPolicyAttribute

    ヘルプとサポート

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

    フィードバック