在某个地域下新增IP访问控制。
接口说明
调用本接口之前,您需要了解:
- 此功能面向 API 提供者。
- IP 访问控制创建后,未绑定 API 前是无意义的,绑定 API 后,对绑定的 API 即时生效。
- 具体的 IP 策略可以在创建 IP 控制时添加
- 当 IP 访问控制下策略为空时,该策略无效。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:CreateIpControl | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
IpControlName | string | 是 | IP 访问控制名称。支持大小写英文字母、中文、数字、下划线(_)、长度为 | controlNameTest |
IpControlType | string | 是 | IP 访问控制类型:
| ALLOW |
Description | string | 否 | 描述,不超过 200 个字符 | test |
IpControlPolicys | array<object> | 否 | 由 ipcontrolpolicys 组成的数组格式,返回策略的信息项 | |
object | 否 | |||
AppId | string | 否 | 策略限制的 AppId,只有控制类型为白名单(即 IpControlType 为 ALLOW)时,才可同时增加 AppId 的限制。
| 11111 |
CidrIp | string | 否 | 具体策略的 IP 或者 IP 段
| 114.1.1.0/24 |
返回参数
示例
正常返回示例
JSON
格式
{
"IpControlId": "7ea91319a34d48a09b5c9c871d9768b1",
"RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史