首页 云连接器 开发参考 API参考 API目录 连接池 CreateConnectionPool - 创建连接地址池

CreateConnectionPool - 创建连接地址池

更新时间: 2023-04-07 17:45:29

创建连接地址池。

调试

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

调试

授权信息

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

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

请求参数

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

云连接器实例ID。

iotcc-bp1odcab8tmno0hdq****
Countlong

连接地址池的IP数量。取值范围:1~500

2
ConnectionPoolNamestring

连接地址池的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。但不能以http:// https://开头。

pool01
ConnectionPoolDescriptionstring

连接地址池的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http:// https://开头。

pool01
Cidrsarray

连接地址池所属的CIDR地址块。N的取值范围:1~20

多个CIDR地址块使用and(&)分隔,格式为Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2

string

连接地址池所属的CIDR地址块。N的取值范围:1~20

多个CIDR地址块使用and(&)分隔,格式为Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2

Cidrs.1=192.168.XX.XX/24&Cidrs.2=10.0.XX.XX/24
ClientTokenstring

客户端Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。

说明若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
123e4567-e89b-12d3-a456-426655440000
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会创建连接地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建连接地址池。
false
RegionIdstring

云连接器实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求ID。

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

连接地址池的ID。

cp-bp11234abctmno0hdq****

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ConnectionPoolId": "cp-bp11234abctmno0hdq****"
}

错误码

HTTP status code错误码错误信息描述
400QuotaExceeded.CIDRLimitThe quota of cidr_limit is exceeded.连接池CIDR列表长度超配额。
400Forbidden.IPUsedInCIDRIP has been used in CIDR.CIDR中有IP已经被使用。
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceInUse.IoTCloudConnectorThe specified resource of IoTCC is in use.iotcc下有connection_pool未删除
400ResourceNotFound.IoTCloudConnectorThe param of IoTCloudConnectorId is illegal.IoTCloudConnectorId参数非法
400ResourceInCreating.IoTCloudConnectorThe specified resource of IoTCloudConnector is creating, please try again later.-
400ResourceInConfiguring.IoTCloudConnectorThe specified resource of IoTCloudConnector is configuring, please try again later.iotcc状态非稳态,或者锁冲突
400QuotaExceeded.ConnectionPoolPerIoTCCThe quota of ConnectionPoolPerIoTCC is exceededConnectionPoolPerIoTCC quota超出
400IllegalParamFormatThe param is illegal.-
400IllegalParam.CidrsThe param of Cidrs is illegal.cidrs参数错误
400IllegalParamSize.CidrThe param size of Cidr is illegal, only support one.Cidr参数大小现在只能支持1。
400OperationDenied.GrantedInstanceNotSupportThe operation is not allowed because of granted instance not support.授权实例不允许IP管理相关操作。
400OperationDenied.CC5GInstanceNotSupportThe operation is not allowed because of CC5G instance not support.CC5G托管实例不支持此操作。

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

变更历史

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