查看APP已绑定的API列表
功能介绍
查询APP已经绑定的API列表。
将API发布到相应的授权的环境后,才能查询到结果。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
| 请求方法 | URI |
|---|---|
| GET | /v1.0/apigw/app-auths/binded-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,env_id] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:app_id、 api_id 、 api_name、group_id、group_name、env_id、page_size、page_no。
URI中的参数说明如下表所示。
| 名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | String | 应用编号 |
| api_id | 否 | String | API编号 |
| api_name | 否 | String | API名称 |
| group_id | 否 | String | API分组编号 |
| group_name | 否 | String | API分组名称 |
| env_id | 否 | String | 授权的环境编号 |
| page_size | 否 | Integer | 每页显示的条数,默认值:20 |
| page_no | 否 | Integer | 页码,默认值:1 |
请求消息
无
响应消息
| 名称 | 类型 | 说明 |
|---|---|---|
| total | Integer | 符合条件的API总数 |
| size | Integer | 本次返回的列表长度 |
| auths | 字典数据类型 | 本次返回的API列表 |
| 名称 | 类型 | 说明 |
|---|---|---|
| id | String | 授权关系编号 |
| api_id | String | API的编号 |
| api_name | String | API的名称 |
| group_name | String | API绑定的分组 |
| api_remark | String | API的描述信息 |
| api_type | Integer | API类型 |
| envname | String | API授权绑定的环境名称 |
| env_id | String | API授权绑定的环境编号 |
| auth_role | String | 授权者 |
| auth_time | String | 授权创建的时间 |
| appid | String | APP的编号 |
| app_name | String | APP的名称 |
| app_creator | String | APP的创建者,取值如下:
|
| app_remark | String | APP的描述信息 |
| app_type | String | APP的类型 |
| publish_id | String | API的发布编号 |
响应消息样例:
{
"total": 1,
"size": 1,
"auths": [{
"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a",
"api_id": "6632a062-9dcf-4f18-9646-3cabb925a290",
"api_name": "查询API列表",
"group_name": "api_group_001",
"api_type": 1,
"api_remark": "查询API列表",
"envname": "RELEASE",
"auth_role": "PROVIDER",
"auth_time": "2017-12-28T12:46:43Z",
"appid": "14b399ac-967f-4115-bb62-c0346b4537e9",
"app_name": "app_001",
"app_creator": "USER",
"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"app_remark": "APP的描述信息",
"app_type": "apig",
"publish_id": "f500ba7e369b4b1ebae99aa9d114a17a"
}]
} 状态码
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |