文档首页/ API网关 APIG/ API参考专享版 (巴黎区域) / 专享版API（V2）/ 专享版-API绑定ACL策略/ 将API与ACL策略进行绑定
更新时间：2023-12-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

将API与ACL策略进行绑定

功能介绍

将API与ACL策略进行绑定。

同一个API发布到不同的环境可以绑定不同的ACL策略；一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

acl_id

否

String

ACL策略编号

publish_ids

否

Array of strings

API发布记录编号

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

acl_bindings

Array of AclApiBindingInfo objects

API与ACL的绑定关系列表
表5 AclApiBindingInfo

参数

参数类型

描述

id

String

绑定关系编号

api_id

String

API编号

env_id

String

环境编号

acl_id

String

ACL策略编号

create_time

String

绑定时间

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

将API与ACL策略进行绑定

{
  "acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
  "publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ]
}

响应示例

状态码： 201

Created

{
  "acl_bindings" : [ {
    "id" : "332c5db1458a477b89b2ea741fec94a3",
    "api_id" : "5f918d104dc84480a75166ba99efff21",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
    "create_time" : "2020-08-04T08:58:03.001228747Z"
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:acl_id. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3006",
  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。