首页 云连接器 开发参考 API参考 API目录 连接池 ListConnectionPoolIps - 查询连接地址池中的IP地址状态

ListConnectionPoolIps - 查询连接地址池中的IP地址状态

更新时间: 2023-04-07 17:46:03

查询连接地址池中的IP地址状态信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
iotcc:ListConnectionPoolIpsRead
  • UIS
    acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}

请求参数

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

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

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

分页大小,取值:1~2000。传入为空时,默认值为10

10
RegionIdstring

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

cn-hangzhou
IoTCloudConnectorIdstring

云连接器实例ID。

iotcc-bp1odcab8tmno0hdq****
ConnectionPoolIdstring

连接地址池的ID。

cp-bp11234abctmno0hdq****
Ipstring

连接地址池中的IP地址。

192.168.XX.XX

返回参数

名称类型描述示例值
object

返回请求列表。

RequestIdstring

请求ID。

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

连接地址池IP总数。

2
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

分页大小。

10
ConnectionPoolIpsarray

连接地址池IP列表。

object

连接地址池IP列表。

ConnectionPoolIdstring

连接地址池ID。

cp-bp11234abctmno0hdq****
Ipstring

连接地址池中的IP地址。

192.168.XX.XX
Statusstring

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

activated

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 2,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 10,
  "ConnectionPoolIps": [
    {
      "ConnectionPoolId": "cp-bp11234abctmno0hdq****",
      "Ip": "192.168.XX.XX",
      "Status": "activated"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。

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

变更历史

变更时间变更内容概要操作
2021-11-18OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
阿里云首页 云连接器 相关技术圈