tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssociatedInstanceList

Last updated: 2023-05-04 17:40:16

1. API Description

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

This API is used to get the list of instances associated with a security group.

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: DescribeAssociatedInstanceList.
Version Yes String Common Params. The value used for this API: 2019-09-04.
Region No String Common Params. This parameter is not required for this API.
Offset Yes Integer List offset
Limit Yes Integer Number of records per page
Area Yes String Region code (e.g. ap-guangzhou). All Tencent Cloud regions are supported.
SearchValue No String Additional search criteria (JSON string)
By No String Sorting field
Order No String Sort order. asc: ascending; desc: descending
SecurityGroupId No String Security group ID
Type No String Instance type. '3': CVM instance; '4': CLB instance; '5': ENI instance; '6': Cloud database

3. Output Parameters

Parameter Name Type Description
Total Integer Number of instances
Note: This field may return null, indicating that no valid value was found.
Data Array of AssociatedInstanceInfo Instance list
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of instances associated with a security group

Input Example

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

{
    "Area": "xx",
    "SecurityGroupId": "xx",
    "SearchValue": "xx",
    "By": "xx",
    "Limit": 1,
    "Offset": 1,
    "Type": "xx",
    "Order": "xx"
}

Output Example

{
    "Response": {
        "Data": [
            {
                "InstanceId": "eni-4ymwnaoe",
                "InstanceName": "test-private",
                "Type": 5,
                "VpcId": "vpc-406waega",
                "VpcName": "vpc---",
                "PublicIp": "",
                "Ip": "192.168.0.13,192.168.0.3",
                "SecurityGroupCount": 1
            },
            {
                "InstanceId": "eni-oskydbvm",
                "InstanceName": "privat-test",
                "Type": 5,
                "VpcId": "vpc-dvc0qmmm",
                "VpcName": "Dno",
                "PublicIp": "",
                "Ip": "172.21.0.12",
                "SecurityGroupCount": 0
            }
        ],
        "Total": 2,
        "RequestId": "8f563b4d-8151-4db0-a822-9bde279d2079"
    }
}

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
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
LimitExceeded The quota limit has been reached.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy