查询云连接地址池。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IoTCloudConnectorId | string | 是 | 云连接器实例 ID。 | iotcc-bp1odcab8tmno0hdq**** |
| ConnectionPoolIds | array | 否 | 连接地址池的 ID 列表。最多支持传入 20 个连接地址池 ID。 | |
| string | 否 | 连接地址池的 ID 列表。最多支持传入 20 个连接地址池 ID。 | cp-bp11234abctmno0hdq**** | |
| ConnectionPoolName | array | 否 | 连接地址池的名称。最多支持传入 20 个连接地址池名称。 名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。 | |
| string | 否 | 连接地址池的名称。最多支持传入 20 个连接地址池名称。 名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。 | pool01 | |
| ConnectionPoolStatus | array | 否 | 连接地址池的状态。最多支持传入 20 个连接地址池状态。
| |
| string | 否 | 连接地址池的状态。最多支持传入 20 个连接地址池状态。取值：
| Running | |
| NextToken | string | 否 | 用来标记当前开始读取的位置，置空表示从头开始。 说明
第一次调用不用填写，会在返回结果中包含第二次调用时用的 NextToken，之后每次调用返回结果中都有下一次调用时的 NextToken。
| caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults | integer | 否 | 本次读取的最大数据记录数量，取值：1~50。传入为空时，默认值为 10。 | 10 |
| RegionId | string | 是 | 云连接器实例所在的地域 ID，仅取值：cn-hangzhou。 | cn-hangzhou |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Forbidden.RAM | Ram user does not have permission to perform this operation. | RAM用户无权限执行此操作。 |
| 400 | ResourceNotFound.IoTCloudConnector | The param of IoTCloudConnectorId is illegal. | IoTCloudConnectorId参数非法 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2021-11-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|