查看ACL策略未绑定的API列表
功能介绍
查看ACL策略未绑定的API列表,需要API已发布。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
| 请求方法 | URI |
|---|---|
| GET | /v1.0/apigw/acl-bindings/unbinded-apis[?page_no、page_size、acl_id、env_id、api_id、api_name、group-id] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:acl_id、env_id、api_id、group_id、api_name、page_size、page_no。
URI中的参数说明如下表所示。
| 名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| acl_id | 是 | String | ACL策略编号 |
| env_id | 否 | String | 环境编号 |
| group_id | 否 | String | API分组编号 |
| api_id | 否 | String | API编号 |
| api_name | 否 | String | API名称 |
| page_size | 否 | Integer | 每页显示的条数,默认值:20 |
| page_no | 否 | Integer | 页码,默认值:1 |
请求消息
无
响应消息
| 参数 | 类型 | 说明 |
|---|---|---|
| total | Integer | 符合条件的API总数 |
| size | Integer | 本次查询返回的API个数 |
| apis | 字典数据类型 | 本次查询返回的API列表 |
| 参数 | 类型 | 说明 |
|---|---|---|
| id | String | API的ID。 |
| name | String | API名称 |
| group_id | String | API所属分组的编号 |
| group_name | String | API所属分组的名称。 |
| type | Integer | API开放状态 |
| remark | String | API描述 |
| run_env_name | String | 发布的环境名 |
| run_env_id | String | 发布的环境id |
| publish_id | String | API发布记录编号 |
| acl_name | String | 绑定的其他同类型的ACL策略名称 |
| req_uri | String | API的访问地址 |
| auth_type | String | API的认证方式 |
响应消息样例:
{
"total": 1,
"size": 1,
"apis": [
{
"name": "bbbbb",
"type": 1,
"remark": "aaa",
"group_id": "70f1b578da9b4dfe889b4c33d1b995c2",
"id": "91c26288acea4448be205265d77dae22",
"group_name": "test001",
"run_env_name": "RELEASE",
"run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"publish_id": "a6e06a00c382436eb524fa2dd343cb6d",
"req_uri": "/test",
"auth_type": "NONE"
}
]
} 状态码
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |