绑定IP地址组与监听器 - AssociateListener
功能介绍
绑定IP地址组与监听器。
该接口属于异步接口,接口返回后,后台的绑定任务仍在执行;可以使用查询IP地址组详情接口查询状态,当IP地址组状态为ACTIVE时,表示绑定完成。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ga:ipgroup:associateListener
Write
ipgroup *
-
-
-
URI
POST /v1/ip-groups/{ip_group_id}/associate-listener
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
ip_group_id | 是 | String | IP地址组ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
listener_id | 是 | String | 监听器ID。 |
type | 是 | String | 访问控制策略类型,即黑名单还是白名单, 取值:
|
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
request_id | String | 请求ID。 |
请求示例
绑定IP地址组与监听器,设置访问控制策略类型为黑名单。
POST https://{ga_endpoint}/v1/ip-groups/e8996cd6-28cf-4ff2-951e-fa8ac895a6cd/associate-listener
{
"listener_id" : "e8996cd6-28cf-4ff2-951e-fa8ac895a6cd",
"type" : "BLACK"
} 响应示例
状态码:200
操作成功
{
"request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8"
} 状态码
状态码 | 描述 |
|---|---|
200 | 操作成功 |
错误码
请参见错误码。

