说明:
1. 接口描述
本接口(DescribeSecurityGroupEx)用于根据多种索引查询一个或多个安全组的基本信息。
接口请求域名:dfw.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为 DescribeSecurityGroupEx。
参数名称 | 必选 | 类型 | 描述 |
projectId | 否 | Int | 项目 Id,不传返回所有项目的安全组列表 |
sgId | 否 | String | 按 sgId 过滤结果,仅支持精确过滤 |
sgName | 否 | String | 按 sgName 过滤结果,支持模糊过滤 |
offset | 否 | Int | 初始的页偏移量,默认为 0。在将来的 V3 版中会改成行偏移量。目前建议使用 offsetLine。 |
offsetLine | 否 | Int | 初始的行偏移量,默认为 0。不能与 offset 同时传入。 |
limit | 否 | Int | 每页行数,默认为 20。 |
3. 输出参数
参数名称 | 类型 | 描述 |
code | Int | 错误码, 0:成功,其他值:失败 |
message | String | 错误信息 |
data.totalNum | Int | 开发商安全组总数 |
data.detail | Array | 返回的数据结构 |
detail 结构
参数名称 | 类型 | 描述 |
detail.n.sgId | String | 安全组 Id |
detail.n.sgName | String | 安全组名 |
detail.n.sgRemark | String | 安全组备注 |
detail.n.createTime | String | 安全组创建时间 |
detail.n.projectId | Int | 项目 Id |
detail.n.beAssociateCount | Int | 被安全组引用个数 |
4. 错误码表
错误码数值 | 原因 |
7000 | 安全组后台异常 |
5. 示例
输入
https://dfw.api.qcloud.com/v2/index.php?Action=DescribeSecurityGroupEx
输出
{"code": 0,"message": "","data":{"totalNum":50,"detail": [{"sgId": "sg-k3tjgics","sgName": "test","sgRemark": "","createTime": "2015-05-20 16:07:58","projectId": 1002207,"beAssociateCount": 0},{"sgId": "sg-56p1yd1o","sgName": "示例安全组","sgRemark": "","createTime": "2015-10-15 17:12:17","projectId": 1003744,"beAssociateCount": 0},{"sgId": "sg-ooa41c4o","sgName": "示例安全组","sgRemark": "","createTime": "2015-09-11 16:12:28","projectId": 1002110,"beAssociateCount": 0},{"sgId": "sg-7tk6qery","sgName": "示例安全组","sgRemark": "","createTime": "2015-10-15 17:12:13","projectId": 1003774,"beAssociateCount": 0},{"sgId": "sg-cqovl1fw","sgName": "示例安全组","sgRemark": "","createTime": "2015-05-22 19:15:38","projectId": 1002443,"beAssociateCount": 0},{"sgId": "sg-exnsygsm","sgName": "test1","sgRemark": "","createTime": "2015-08-25 17:07:25","projectId": 0,"beAssociateCount": 0},{"sgId": "sg-9g8qfrwi","sgName": "一二三四五六七八九十_-...12345","sgRemark": "","createTime": "2015-08-25 17:07:47","projectId": 0,"beAssociateCount": 0},{"sgId": "sg-gte8a2ys","sgName": "694949","sgRemark": "","createTime": "2015-05-25 15:48:24","projectId": 1002026,"beAssociateCount": 0},{"sgId": "sg-fdn9vtdy","sgName": "314294","sgRemark": "","createTime": "2015-05-25 15:42:13","projectId": 1002026,"beAssociateCount": 0},{"sgId": "sg-p837l8ko","sgName": "532215","sgRemark": "","createTime": "2015-05-25 13:27:12","projectId": 1002026,"beAssociateCount": 0},{"sgId": "sg-de37xrpo","sgName": "740402","sgRemark": "","createTime": "2015-05-25 13:27:13","projectId": 1002026,"beAssociateCount": 0,"version": 0},{"sgId": "sg-bvdaobny","sgName": "427637","sgRemark": "","createTime": "2015-05-25 13:25:53","projectId": 1002026,"beAssociateCount": 0,"version": 0},{"sgId": "sg-kqj119xe","sgName": "795911","sgRemark": "","createTime": "2015-05-25 13:26:22","projectId": 1002026,"beAssociateCount": 0,"version": 0}]}}