黑石EIP查询接口

最近更新时间:2019-01-24 16:22:59

1. 接口描述

接口请求域名: bmeip.tencentcloudapi.com 。

黑石EIP查询接口

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeEips
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
EipIds.N Array of String EIP实例ID列表
Eips.N Array of String EIP IP 列表
InstanceIds.N Array of String 主机实例ID 列表
SearchKey String EIP名称,模糊匹配
Status.N Array of Integer 状态列表, 默认所有
Offset Integer 偏移量,默认为0
Limit Integer 返回EIP数量,默认 20, 最大值 100
OrderField String 排序字段,支持: EipId,Eip,Status, InstanceId,CreatedAt
Order Integer 排序方式 0:递增 1:递减(默认)
PayMode String 计费模式,流量:flow,带宽:bandwidth
VpcId String EIP归属VpcId,例如vpc-k7j1t2x1
BindTypes.N Array of Integer 绑定类型,-1:未绑定,0:物理机,1:nat网关,2:虚拟IP, 3:托管机器
ExclusiveTag Integer 独占标志,0:共享,1:独占
AclId Integer EIP ACL实例ID
BindAcl Integer 搜索条件,是否绑定了EIP ACL, 0:未绑定,1:绑定

3. 输出参数

参数名称 类型 描述
EipSet Array of EipInfo 返回EIP信息数组
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询EIP列表

输入示例

https://bmvpc.tencentcloudapi.com/?Action=DescribeEips
&EipIds.0=eip-lcwonw3s
&<公共请求参数>

输出示例

{
    "Response": {
        "EipSet": [
            {
                "EipId": "eip-lcwonw3s",
                "EipName": "",
                "Eip": "211.159.194.102",
                "IspId": 5,
                "Status": 2,
                "Arrears": 0,
                "InstanceId": "cpm-9p045zd4",
                "InstanceAlias": "dandan_os测试_ubuntu16.04",
                "FreeAt": "2018-10-25 15:15:32",
                "CreatedAt": "2018-10-25 15:15:18",
                "UpdatedAt": "2018-10-25 16:00:09",
                "FreeSecond": 0,
                "Type": 0,
                "PayMode": "flow",
                "Bandwidth": 512,
                "LatestPayMode": "flow",
                "LatestBandwidth": 512,
                "VpcName": "HEISHI_VPC_勿删",
                "NatId": -1,
                "NatUid": "",
                "VpcIp": "",
                "VpcId": "vpc-bjh0qd20",
                "Exclusive": 0,
                "VpcCidr": "10.1.0.0/16",
                "AclId": "",
                "AclName": "",
                "HInstanceId": "",
                "HInstanceAlias": ""
            }
        ],
        "RequestId": "51369791-7ffa-42b1-9a0e-f21b88d7d68a"
    }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码