文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-凭据管理/ 设置APP的访问控制
更新时间：2024-11-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置APP的访问控制

功能介绍

设置凭据的访问控制。

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

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

app_id

是

String

应用编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

app_acl_type

是

String

类型

  • PERMIT (白名单类型)

  • DENY (黑名单类型)

app_acl_values

是

Array of strings

ACL策略值，支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

app_id

String

APP编号

app_acl_type

String

类型

  • PERMIT (白名单类型)

  • DENY (黑名单类型)

app_acl_values

Array of strings

ACL策略值，支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{
  "app_acl_type" : "PERMIT",
  "app_acl_values" : [ "192.168.0.1", "192.168.0.5-192.168.0.10", "192.168.0.100/28" ]
}

响应示例

状态码： 201

Ok

{
  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
  "app_acl_type" : "PERMIT",
  "app_acl_values" : [ "192.168.0.1", "192.168.0.5-192.168.0.10", "192.168.0.100/28" ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:app_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.3004",
  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
}

状态码： 500

Internal Server Error

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

状态码

状态码

描述

201

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-凭据管理