文档中心>黑石弹性公网 IP

黑石EIP查询接口

最近更新时间:2024-03-12 01:10:57

我的收藏

1. 接口描述

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

黑石EIP查询接口

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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 String EIP ACL实例ID
BindAcl Integer 搜索条件,是否绑定了EIP ACL, 0:未绑定,1:绑定

3. 输出参数

参数名称 类型 描述
EipSet Array of EipInfo 返回EIP信息数组
TotalCount Integer 返回EIP数量
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询EIP列表

输入示例

POST / HTTP/1.1
Host: bmeip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEips
<公共请求参数>

{
    "SearchKey": "xx",
    "Status": [
        0
    ],
    "VpcId": "xx",
    "ExclusiveTag": 0,
    "BindTypes": [
        0
    ],
    "AclId": "xx",
    "EipIds": [
        "eip-lcwonw3s"
    ],
    "PayMode": "xx",
    "Eips": [
        "xx"
    ],
    "Limit": 0,
    "OrderField": "xx",
    "Offset": 0,
    "BindAcl": 0,
    "Order": 0,
    "InstanceIds": [
        "xx"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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