文档

AssociateIpWithConnectionPool - 绑定IP地址与云连接器关联的连接地址池

更新时间:

绑定某个已存在的IP访问控制。

调试

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

授权信息

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

请求参数

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

保证请求幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

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

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

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

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

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

cn-hangzhou
IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
ConnectionPoolIdstring

连接地址池 ID。

cp-bp11234abctmno0hdq****
Ipsarray

要绑定的 IP 地址列表。 最多支持传入 500 个 IP 地址。多个 IP 地址使用半角逗号(,)分隔。

string

要绑定的 IP 地址列表。 最多支持传入 500 个 IP 地址。多个 IP 地址使用半角逗号(,)分隔。

IpsIpsFilePath 不能同时填写,如果 IP 数量较少,可直接选择 Ips 方式,如果 IP 数量较多,建议选择 IpsFilePath 方式,将需要绑定的 IP 地址记录在模板文件中,整体绑定。

192.168.1.10,10.0.10.0,172.16.8.190
IpsFilePathstring

模板文件 OSS 地址,即 GetStsInfoAndOssPath 接口的返回参数 OssPath

格式为<BucketName>/<uid>/<FileName>

IpsIpsFilePath 不能同时填写,如果 IP 数量较少,可直接选择 Ips 方式,如果 IP 数量较多,建议选择 IpsFilePath 方式,将需要绑定的 IP 地址记录在模板文件中,整体绑定。

cciot-cn-hangzhou/127859184306****/test.csv

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceNotFound.UploadFileThe specified resource of uploaded ip file is not found.输入的IP文件未找到。
400MissingParam.IpParamThe param of ip or ip path is missing.-
400IllegalParamFormatThe param is illegal.-
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托管实例不支持此操作。
400ResourceInConfiguring.APNThe specified resource of apn is being configured, please try again later.APN当前处于变配中状态,请稍后再试。

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

变更历史

变更时间变更内容概要操作
2021-11-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈