说明:
1. 接口描述
本接口(DescribeInstancesOfSecurityGroup)用于查询已关联指定的安全组的云服务器。
接口请求域名:dfw.api.qcloud.com
1. 此接口允许查询云服务器列表中的一部分成员信息,使用 offset 和 limit 两个输入字段控制。不输入时,默认查询前20台云服务器。
2. 一台云服务器允许关联多个安全组,在不同安全组的查询结果中可能有重复的云服务器实例 ID。
3. 云服务器列表以列表方式返回,列表成员是云服务器的实例 ID。
特别提示:为提供更丰富的按安全组查询绑定实例的需求,建议客户使用各类云资源的实例查询接口,在这些接口中使用安全组 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"}]}