tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSnapshotAttachedInstances

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

1. API Description

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

This API is used to query instances associated with a snapshot policy.

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: DescribeSnapshotAttachedInstances.
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.
SnapshotPolicyId Yes String Snapshot policy IDs
Filters.N No Array of Filter Filters
Values:
  • instance-id: Instance ID
  • instance-region: Instance region
    		•
    Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 200.

    3. Output Parameters

    Parameter Name Type Description
    InstanceSet Array of SnapshotInstance List of instances
    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 instances associated with a snapshot policy

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeSnapshotAttachedInstances
&SnapshotPolicyId=sspolicy-g6jwvm35
&Offset=0
&Limit=2
&Filters.0.Name=uniqInstanceId
&Filters.0.Values.0=sg-ntrgm89v
&<Common request parameters>

    Output Example

    {
    "Response": {
        "InstanceSet": [
            {
                "InstanceId": "sg-ntrgm89v",
                "InstanceRegion": "ap-shanghai",
                "InstanceType": "securitygroup",
                "SnapshotPolicyId": "sspolicy-g6jwvm35",
                "InstanceName": "test11111"
            }
        ],
        "TotalCount": 1,
        "RequestId": "2099cfcf-fe15-4825-93a1-642c9ad2630f"
    }
}

    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.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy