文档

ListConnectionPools - 查询云连接地址池

更新时间:

查询云连接地址池。

调试

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

授权信息

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

请求参数

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

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
ConnectionPoolIdsarray

连接地址池的 ID 列表。最多支持传入 20 个连接地址池 ID。

string

连接地址池的 ID 列表。最多支持传入 20 个连接地址池 ID。

cp-bp11234abctmno0hdq****
ConnectionPoolNamearray

连接地址池的名称。最多支持传入 20 个连接地址池名称。

名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。

string

连接地址池的名称。最多支持传入 20 个连接地址池名称。

名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。

pool01
ConnectionPoolStatusarray

连接地址池的状态。最多支持传入 20 个连接地址池状态。

  • Creating:创建中。
  • Running:运行中。
  • Deleting:删除中。
  • Deleted:已删除。
  • Associating:IP 绑定中。
  • Dissociating:IP 解绑中。
string

连接地址池的状态。最多支持传入 20 个连接地址池状态。取值:

  • Creating:创建中。
  • Running:运行中。
  • Deleting:删除中。
  • Deleted:已删除。
  • Associating:IP 绑定中。
  • Dissociating:IP 解绑中。
Running
NextTokenstring

用来标记当前开始读取的位置,置空表示从头开始。

说明 第一次调用不用填写,会在返回结果中包含第二次调用时用的 NextToken,之后每次调用返回结果中都有下一次调用时的 NextToken。
caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

本次读取的最大数据记录数量,取值:1~50。传入为空时,默认值为 10

10
RegionIdstring

云连接器实例所在的地域 ID,仅取值:cn-hangzhou

cn-hangzhou

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCountinteger

连接地址池总数。

2
NextTokenstring

下一个查询开始的 Token,为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

本次请求所返回的最大记录条数量。

10
ConnectionPoolsobject []

连接地址池信息。

ConnectionPoolIdstring

连接地址池 ID。

cp-bp11234abctmno0hdq****
ConnectionPoolStatusstring

连接地址池的状态。取值:

  • Creating:创建中。
  • Running:运行中。
  • Deleting:删除中。
  • Deleted:已删除。
  • Associating:IP 绑定中。
  • Dissociating:IP 解绑中。
Running
ConnectionPoolNamestring

连接地址池的名称。

pool01
ConnectionPoolDescriptionstring

连接地址池的描述信息。

pool01
Cidrsarray

连接地址池所属的 CIDR 地址块。

string

连接地址池所属的 CIDR 地址块。

192.168.XX.XX/32
OperateResultRequestIDstring

上一次绑定解绑调用返回的 RequestId。可以根据此 ID 调用 GetConnectionPoolIpOperationResult 返回绑定解绑的失败原因。

CEF72CEB-54B6-4AE8-B225-F876FF7BA651

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 2,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 10,
  "ConnectionPools": [
    {
      "ConnectionPoolId": "cp-bp11234abctmno0hdq****",
      "ConnectionPoolStatus": "Running",
      "ConnectionPoolName": "pool01",
      "ConnectionPoolDescription": "pool01",
      "Cidrs": [
        "192.168.XX.XX/32"
      ],
      "OperateResultRequestID": "CEF72CEB-54B6-4AE8-B225-F876FF7BA651"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceNotFound.IoTCloudConnectorThe param of IoTCloudConnectorId is illegal.IoTCloudConnectorId参数非法

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

变更历史

变更时间变更内容概要操作
2021-11-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈