文档

ListConnectionPoolAllIps - 查询连接地址池所有IP地址

更新时间:

查询连接地址池所有IP地址信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值:1~50。默认值:10

10
RegionIdstring

云连接器实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
ConnectionPoolIdstring

要查询的连接地址池 ID。

cp-bp11234abctmno0hdq****
Ipstring

连接地址池中的 IP 地址。

192.168.0.1
Typestring

连接地址池中 IP 地址类型。取值:

  • Cidr:连接地址池所属的 CIDR 地址块。

  • Host:物联网卡的 IP 地址。

Cidr

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
TotalIpsCountinteger

总列表条目数。

1
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

10
ConnectionPoolIpsobject []

连接地址池 IP 列表。

ConnectionPoolIdstring

连接地址池 ID。

cp-bp11234abctmno0hdq****
Ipstring

连接地址池中的 IP 地址。

192.168.0.1
Statusstring

IP 地址状态,仅返回 activated,表示已激活,IP 地址和云连接器绑定完成。

activated
Typestring

连接地址池中 IP 地址类型。取值:

  • Cidr:连接地址池所属的 CIDR 地址块。

  • Host:物联网卡的 IP 地址。

Cidr
IpNumlong

可用 IP 数量。

  • Type 取值为 Host 时,可用 IP 数量为 1

  • Type 取值为 Cidr 时,可用 IP 数量为 CIDR 地址块的 IP 总数。

254

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TotalIpsCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "ConnectionPoolIps": [
    {
      "ConnectionPoolId": "cp-bp11234abctmno0hdq****",
      "Ip": "192.168.0.1",
      "Status": "activated",
      "Type": "Cidr",
      "IpNum": 254
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceNotFound.ConnectionPoolThe specified resource of connection pool is not found.未找到连接地址池。

访问错误中心查看更多错误码。

  • 本页导读 (1)