绑定某个已存在的IP访问控制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
iotcc:AssociateIpWithConnectionPool | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 保证请求幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。 | 123e4567-e89b-12d3-a456-426655440000 |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| false |
RegionId | string | 是 | 云连接器实例所在的地域ID。 您可以通过调用ListRegions接口获取地域ID。 | cn-hangzhou |
IoTCloudConnectorId | string | 是 | 云连接器实例ID。 | iotcc-bp1odcab8tmno0hdq**** |
ConnectionPoolId | string | 是 | 连接地址池ID。 | cp-bp11234abctmno0hdq**** |
Ips | array | 否 | 要绑定的IP地址列表。 最多支持传入500个IP地址。多个IP地址使用半角逗号(,)分隔。 | |
string | 否 | 要绑定的IP地址列表。 最多支持传入500个IP地址。多个IP地址使用半角逗号(,)分隔。 Ips和IpsFilePath不能同时填写,如果IP数量较少,可直接选择Ips方式,如果IP数量较多,建议选择IpsFilePath方式,将需要绑定的IP地址记录在模板文件中,整体绑定。 | 192.168.1.10,10.0.10.0,172.16.8.190 | |
IpsFilePath | string | 否 | 模板文件OSS地址,即GetStsInfoAndOssPath接口的返回参数OssPath。 格式为 Ips和IpsFilePath不能同时填写,如果IP数量较少,可直接选择Ips方式,如果IP数量较多,建议选择IpsFilePath方式,将需要绑定的IP地址记录在模板文件中,整体绑定。 | cciot-cn-hangzhou/127859184306****/test.csv |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Forbidden.RAM | Ram user does not have permission to perform this operation. | RAM用户无权限执行此操作。 |
400 | ResourceNotFound.UploadFile | The specified resource of uploaded ip file is not found. | 输入的IP文件未找到。 |
400 | MissingParam.IpParam | The param of ip or ip path is missing. | - |
400 | IllegalParamFormat | The param is illegal. | - |
400 | OperationDenied.GrantedInstanceNotSupport | The operation is not allowed because of granted instance not support. | 授权实例不允许IP管理相关操作。 |
400 | OperationDenied.CC5GInstanceNotSupport | The operation is not allowed because of CC5G instance not support. | CC5G托管实例不支持此操作。 |
400 | ResourceInConfiguring.APN | The specified resource of apn is being configured, please try again later. | APN当前处于变配中状态,请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2021-11-18 | OpenAPI 错误码发生变更 | |||||
|