tencent cloud

文档反馈

DescribeSgSnapshotFileContent

最后更新时间:2024-11-25 20:07:45

    1. API Description

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

    This API is used to query the snapshot file contents.

    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: DescribeSgSnapshotFileContent.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    SnapshotPolicyId Yes String Snapshot policy IDs
    SnapshotFileId Yes String Snapshot file ID
    SecurityGroupId Yes String Security group ID

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Security group ID
    SnapshotPolicyId String Snapshot policy IDs
    SnapshotFileId String Snapshot file ID
    BackupTime String Backup time
    Operator String Operator
    OriginalData Array of SecurityGroupPolicy Original data
    BackupData Array of SecurityGroupPolicy Backup data
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying contents of security group snapshot files

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=DescribeSgSnapshotFileContent
    &SnapshotPolicyId=sspolicy-ebjofe71
    &SnapshotFileId=ssfile-017gepjxpr
    &SecurityGroupId=sg-ntrgm89v
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "InstanceId": "sg-ntrgm89v",
            "SnapshotPolicyId": "sspolicy-ebjofe71",
            "SnapshotFileId": "ssfile-017gepjxpr",
            "BackupTime": "2021-10-25 15:00:10",
            "Operator": "100000072292",
            "OriginalData": [
                {
                    "PolicyIndex": 0,
                    "Protocol": "icmp",
                    "Port": "ALL",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-02 11:24:13",
                    "Action": "DROP",
                    "PolicyDescription": "Allow PING"
                },
                {
                    "PolicyIndex": 1,
                    "Protocol": "icmpv6",
                    "Port": "ALL",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow PING"
                },
                {
                    "PolicyIndex": 2,
                    "Protocol": "tcp",
                    "Port": "22",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Linux SSH login"
                },
                {
                    "PolicyIndex": 3,
                    "Protocol": "tcp",
                    "Port": "22",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Linux SSH login"
                },
                {
                    "PolicyIndex": 4,
                    "Protocol": "tcp",
                    "Port": "3389",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Windows remote login"
                },
                {
                    "PolicyIndex": 5,
                    "Protocol": "tcp",
                    "Port": "3389",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Windows remote login"
                },
                {
                    "PolicyIndex": 6,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "10.0.0.0/8",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow private network access (VPC)"
                },
                {
                    "PolicyIndex": 7,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "172.16.0.0/12",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow private network access (VPC)"
                },
                {
                    "PolicyIndex": 8,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "192.168.0.0/16",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow private network access (VPC)"
                },
                {
                    "PolicyIndex": 0,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT"
                },
                {
                    "PolicyIndex": 1,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT"
                }
            ],
            "BackupData": [
                {
                    "PolicyIndex": 0,
                    "Protocol": "icmp",
                    "Port": "ALL",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-02 11:24:13",
                    "Action": "DROP",
                    "PolicyDescription": "Allow PING"
                },
                {
                    "PolicyIndex": 1,
                    "Protocol": "icmpv6",
                    "Port": "ALL",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow PING"
                },
                {
                    "PolicyIndex": 2,
                    "Protocol": "tcp",
                    "Port": "22",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Linux SSH login"
                },
                {
                    "PolicyIndex": 3,
                    "Protocol": "tcp",
                    "Port": "22",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Linux SSH login"
                },
                {
                    "PolicyIndex": 4,
                    "Protocol": "tcp",
                    "Port": "3389",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Windows remote login"
                },
                {
                    "PolicyIndex": 5,
                    "Protocol": "tcp",
                    "Port": "3389",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow Windows remote login"
                },
                {
                    "PolicyIndex": 6,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "10.0.0.0/8",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow private network access (VPC)"
                },
                {
                    "PolicyIndex": 7,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "172.16.0.0/12",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow private network access (VPC)"
                },
                {
                    "PolicyIndex": 8,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "192.168.0.0/16",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT",
                    "PolicyDescription": "Allow private network access (VPC)"
                },
                {
                    "PolicyIndex": 0,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "CidrBlock": "0.0.0.0/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT"
                },
                {
                    "PolicyIndex": 1,
                    "Protocol": "ALL",
                    "Port": "ALL",
                    "Ipv6CidrBlock": "::/0",
                    "ModifyTime": "2021-09-01 19:16:12",
                    "Action": "ACCEPT"
                }
            ],
            "RequestId": "6886c65f-f9bb-4547-93ee-71f781b0e014"
        }
    }
    

    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.
    ResourceNotFound The resource does not exist.
    UnsupportedOperation.SnapshotFileFailed Failed to generate the snapshot file.
    UnsupportedOperation.SnapshotFileNoExist The snapshot file is expired or has been deleted.
    UnsupportedOperation.SnapshotFileProcessing Generating the snapshot file…Please check again later.