Tencent Cloud

Download PDF

DescribeSnapshotFiles

Last updated: 2023-08-23 14:11:15

Download PDF

1. API Description

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

This API is used to query snapshot files.

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: DescribeSnapshotFiles.
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.
BusinessType	Yes	String	Type of associated resource. Values: `securitygroup`
InstanceId	Yes	String	Service instance ID. It's corresponding to the `BusinessType`.
StartDate	Yes	String	Start time. Format: %Y-%m-%d %H:%M:%S
EndDate	Yes	String	End time. Format: %Y-%m-%d %H:%M:%S
Offset	No	Integer	Offset. Default value: `0`.
Limit	No	Integer	Number of returned results. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
SnapshotFileSet	Array of SnapshotFileInfo	Snapshot files
TotalCount	Integer	The number of eligible objects.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying snapshots of an instance

This example shows you how to query the snapshots of the current instance.

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeSnapshotFiles
&BusinessType=securitygroup
&InstanceId=sg-ntrgm89v
&StartDate=2021-10-10 00:00:00
&EndDate=2021-10-30 19:00:00
&<Common request parameters>

Output Example

{
    "Response": {
        "SnapshotFileSet": [
            {
                "InstanceId": "sg-ntrgm89v",
                "SnapshotPolicyId": "sspolicy-ebjofe71",
                "SnapshotFileId": "ssfile-017gepjxpr",
                "BackupTime": "2021-10-25 15:00:10",
                "Operator": "100000072292"
            },
            {
                "InstanceId": "sg-ntrgm89v",
                "SnapshotPolicyId": "sspolicy-ebjofe71",
                "SnapshotFileId": "ssfile-ibvthz32h3",
                "BackupTime": "2021-10-25 00:00:10",
                "Operator": "100000072292"
            },
            {
                "InstanceId": "sg-ntrgm89v",
                "SnapshotPolicyId": "sspolicy-ebjofe71",
                "SnapshotFileId": "ssfile-bu7rtl9145",
                "BackupTime": "2021-10-20 12:01:02",
                "Operator": "100000072292"
            }
        ],
        "TotalCount": 3,
        "RequestId": "a54419ea-8f2d-4d38-a69a-2315d413626f"
    }
}

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

Tencent Cloud CLI 3.0

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	Incorrect parameter value.
InvalidParameterValue.Range	The parameter value is not in the specified range.
ResourceNotFound	The resource does not exist.
UnsupportedOperation.SnapshotNotAttached	The instance is not associated with any snapshot policy.

tencent cloud

Recent Pages

DescribeSnapshotFiles

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying snapshots of an instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeSnapshotFiles

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying snapshots of an instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?