API文档

查询DhcpIp列表

最近更新时间:2020-07-13 08:56:44

1. 接口描述

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

本接口(DescribeDhcpIps)用于查询DhcpIp列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDhcpIps。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DhcpIpIds.N Array of String DhcpIp实例ID。形如:dhcpip-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定DhcpIpIds和Filters。
Filters.N Array of Filter 过滤条件,参数不支持同时指定DhcpIpIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
  • subnet-id - String - (过滤条件)所属子网实例ID,形如:subnet-f49l6u0z。
  • dhcpip-id - String - (过滤条件)DhcpIp实例ID,形如:dhcpip-pxir56ns。
  • dhcpip-name - String - (过滤条件)DhcpIp实例名称。
  • address-ip - String - (过滤条件)DhcpIp实例的IP,根据IP精确查找。
  • Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    DhcpIpSet Array of DhcpIp 实例详细信息列表。
    TotalCount Integer 符合条件的实例数量。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询DhcpIp列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeDhcpIps
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DhcpIpSet": [
          {
            "DhcpIpId": "dhcpip-12345678",
            "DhcpIpName": "test",
            "PrivateIpAddress": "10.0.0.13",
            "VpcId": "vpc-12345678",
            "SubnetId": "subnet-12345678",
            "NetworkInterfaceId": "",
            "InstanceId": "",
            "AddressIp": "",
            "State": "UNBIND",
            "CreatedTime": "2018-10-10 17:03:09"
          }
        ],
        "TotalCount": 1,
        "RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
      }
    }

    示例2 根据DhcpIpIds查询DhcpIp列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeDhcpIps
    &DhcpIpIds.0=dhcpip-12345678
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DhcpIpSet": [
          {
            "DhcpIpId": "dhcpip-12345678",
            "DhcpIpName": "test",
            "PrivateIpAddress": "10.0.0.13",
            "VpcId": "vpc-12345678",
            "SubnetId": "subnet-12345678",
            "NetworkInterfaceId": "",
            "InstanceId": "",
            "AddressIp": "",
            "State": "UNBIND",
            "CreatedTime": "2018-10-10 17:03:09"
          }
        ],
        "TotalCount": 1,
        "RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
      }
    }

    示例3 根据Filters查询DhcpIp列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeDhcpIps
    &Filters.0.dhcpip-id.0=dhcpip-12345678
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DhcpIpSet": [
          {
            "DhcpIpId": "dhcpip-12345678",
            "DhcpIpName": "test",
            "PrivateIpAddress": "10.0.0.13",
            "VpcId": "vpc-12345678",
            "SubnetId": "subnet-12345678",
            "NetworkInterfaceId": "",
            "InstanceId": "",
            "AddressIp": "",
            "State": "UNBIND",
            "CreatedTime": "2018-10-10 17:03:09"
          }
        ],
        "TotalCount": 1,
        "RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    目录