查询IP地址

最近更新时间:2017-09-18 14:36:00

1. 接口描述

本接口(DescribeAddress)用于查询(网络)参数模板IP地址列表。
接口请求域名:vpc.api.qcloud.com

2. 输入参数

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

参数名称 必选 类型 描述
addressId String IP 地址 ID,支持模糊搜索。
addressName String IP 地址名称,支持模糊搜索。
offset Int 初始行的偏移量,默认为 0。
limit Int 每页行数,默认为 20。

注:addressId 和 addressName 作为查询条件为逻辑与关系

3. 输出参数

参数名称 类型 描述
code Int 数字错误码, 0表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 错误信息。
codeDesc String 英文错误码 。
data Object 返回的数据结构。

data 结构

参数名称 类型 描述
data.totalCount Int 返回的IP地址总数。
data.data Array IP 地址详情列表。

data.data 结构

参数名称 类型 描述
data.n.addressId String IP 地址 ID。
data.n.addressName String IP 地址名称。
data.n.address Array IP 地址成员。
data.n.createTime String 创建时间。

data.n.address结构

参数名称 类型 描述
data.n.address.n String IP 地址成员。

4. 错误码表

错误码数值 原因
29257 后台错误,请求失败。
29258 引用资源不存在。
29259 关联对象因规则展开过大拒绝您的关联。
29260 参数模板总数或成员数使用超限。
29254 鉴权失败。
9003 参数错误。
9005 系统忙或有相关资源正在被编辑。

5. 示例

输入


  https://vpc.api.qcloud.com/v2/index.php?Action=DescribeAddress
  &<公共请求参数>
  &addressId=k

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "totalCount": 2,
        "data": [
            {
                "addressId": "ipm-ka2qtxxx",
                "addressName": "aaaa",
                "address": [
                    "1.1.1.1"
                ],
                "createTime": "2017-06-07 20:23:15"
            },
            {
                "addressId": "ipm-kj9grxxx",
                "addressName": "test",
                "address": [
                    "10.0.0.6",
                    "10.0.0.0/16",
                    "10.0.0.1-10.0.0.20"
                ],
                "createTime": "2017-06-06 22:35:19"
            }
        ]
    }
}