查询云连接地址池。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| iotcc:ListConnectionPools | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 错误码发生变更 | |||||
|