调用ListConnectionPoolAllIps查询连接地址池所有IP地址

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值：1~50。默认值：10。	10
RegionId	string	是	云连接器实例所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。	cn-hangzhou
IoTCloudConnectorId	string	是	云连接器实例ID。	iotcc-bp1odcab8tmno0hdq****
ConnectionPoolId	string	是	要查询的连接地址池ID。	cp-bp11234abctmno0hdq****
Ip	string	否	连接地址池中的IP地址。	192.168.0.1
Type	string	否	连接地址池中IP地址类型。取值： Cidr：连接地址池所属的CIDR地址块。 Host：物联网卡的IP地址。	Cidr

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
RequestId	string	请求ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
TotalIpsCount	integer	总列表条目数。	1
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	分批次查询时每次显示的条目数。	10
ConnectionPoolIps	array	连接地址池IP列表。
	object	连接地址池IP列表。
ConnectionPoolId	string	连接地址池ID。	cp-bp11234abctmno0hdq****
Ip	string	连接地址池中的IP地址。	192.168.0.1
Status	string	IP地址状态，仅返回activated，表示已激活，IP地址和云连接器绑定完成。	activated
Type	string	连接地址池中IP地址类型。取值： Cidr：连接地址池所属的CIDR地址块。 Host：物联网卡的IP地址。	Cidr
IpNum	Long	可用IP数量。 Type取值为Host时，可用IP数量为1。 Type取值为Cidr时，可用IP数量为CIDR地址块的IP总数。	254

示例

请求示例

http(s)://[Endpoint]/?Action=ListConnectionPoolAllIps
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=10
&RegionId=cn-hangzhou
&IoTCloudConnectorId=iotcc-bp1odcab8tmno0hdq****
&ConnectionPoolId=cp-bp11234abctmno0hdq****
&Ip=192.168.0.1
&Type=Cidr
&公共请求参数

正常返回示例

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
        }
    ]
}

XML格式

<ListConnectionPoolAllIpsResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <TotalIpsCount>1</TotalIpsCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>10</MaxResults>
    <ConnectionPoolIps>
        <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>
        <Ip>192.168.0.1</Ip>
        <Status>activated</Status>
        <Type>Cidr</Type>
        <IpNum>254</IpNum>
    </ConnectionPoolIps>
</ListConnectionPoolAllIpsResponse>

错误码

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

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