1. 接口描述
本接口(DescribeAddressGroups)用于查询(网络)参数模板 IP 地址组列表。
接口请求域名:vpc.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为 DescribeAddressGroups。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
addressGroupId | 否 | String | IP 地址组 ID,支持模糊搜索。 |
addressGroupName | 否 | String | IP 地址组名称,支持模糊搜索。 |
offset | 否 | Int | 初始行的偏移量,默认为0。 |
limit | 否 | Int | 每页行数,默认为20。 |
注:addressGroupId 和 addressGroupName 作为查询条件为逻辑与关系
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 数字错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 错误信息。 |
codeDesc | String | 英文错误码。 |
data | Object | 返回的数据结构。 |
data 结构
参数名称 | 类型 | 描述 |
---|---|---|
data.totalCount | Int | 返回的 IP 地址组总数。 |
data.data | Array | IP 地址组详情列表。 |
data.data 结构
参数名称 | 类型 | 描述 |
---|---|---|
data.data.n.addressGroupId | String | IP 地址组 ID。 |
data.data.n.addressGroupName | String | IP 地址组名称。 |
data.data.n.addressGroup | Array | IP 地址组成员。 |
data.data.n.createTime | String | 创建时间。 |
data.data.n.addressGroup结构
参数名称 | 类型 | 描述 |
---|---|---|
data.data.n.addressGroup.n | String | IP 地址组成员。 |
4. 错误码表
错误码数值 | 原因 |
---|---|
29257 | 后台错误,请求失败。 |
29258 | 引用资源不存在。 |
29259 | 关联对象因规则展开过大拒绝您的关联。 |
29260 | 参数模板总数或成员数使用超限。 |
29254 | 鉴权失败。 |
9003 | 参数错误。 |
9005 | 系统忙或有相关资源正在被编辑。 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeAddressGroups &<公共请求参数> &addressGroupId=q
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"totalCount": 2,
"data": [
{
"addressGroupId": "ipmg-8sasuc8q",
"addressGroupName": "ddd",
"addressGroup": [
{
"addressId": "ipm-kj9sucnx",
"addressName": "test1"
}
],
"createTime": "2017-06-07 19:39:05"
},
{
"addressGroupId": "ipmg-n28suc8q",
"addressGroupName": "aaaabbb",
"addressGroup": [
{
"addressId": "ipm-kj9sucnx",
"addressName": "test2"
}
],
"createTime": "2017-06-07 17:33:54"
}
]
}
}