查询安全组关联的云主机列表

最近更新时间:2018-03-20 13:07:19

1. 接口描述

本接口(DescribeInstancesOfSecurityGroup)用于查询已关联指定的安全组的云服务器。
接口请求域名:dfw.api.qcloud.com
1)此接口允许查询云服务器列表中的一部分成员信息,使用offset和limit两个输入字段控制。不输入时,默认查询前20台云服务器。
2)一台云服务器允许关联多个安全组,在不同安全组的查询结果中可能有重复的云服务器实例ID。
3)云服务器列表以列表方式返回,列表成员是云服务器的实例ID。

特别提示:为提供更丰富的按安全组查询绑定实例的需求,建议客户使用各类云资源的实例查询接口,在这些接口中使用安全组ID过滤条件。以云服务器为例,
<DescribeInstances> 接口可以使用安全组ID作过滤条件,查询出更为完整的实例信息。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为DescribeInstancesOfSecurityGroup。

参数名称 必选 类型 描述
sgId String 安全组id
offset Int 分页开始位置, 默认值: 0
limit Int 数量限制,默认值: 20

3. 输出参数

参数名称 类型 描述
code Int 错误码, 0: 成功, 其他值: 失败
message String 错误信息
totalCount Int 关联云服务器实例总数
data Array 返回的数据结构

Data结构:

参数名称 类型 描述
instanceId Array 云服务器实例Id,例如ins-a1iofc4j

4. 示例

输入


  https://dfw.api.qcloud.com/v2/index.php?Action=DescribeInstancesOfSecurityGroup
  &sgId=sg-56p1yd1o
  &<公共请求参数>

输出


{
    "code": 0,
    "message": "",
   "totalCount":0,
    "data": [
            {
                "instanceId": "ins-tks7a12z"
            }
     ]
}