查看APP未绑定的API列表
功能简介
查询指定环境上某个APP未绑定的API列表,包括自有API。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
请求方法 |
URI |
---|---|
GET |
/v1.0/apigw/app-auths/unbinded-apis[?page_size, page_no, app_id, env_id, api_id, api_name, group_id] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:app_id、api_id、api_name、group_id、env_id、page_size、page_no。
URI中的参数说明如下表所示。
名称 |
是否必选 |
类型 |
说明 |
---|---|---|---|
app_id |
是 |
String |
应用id |
env_id |
是 |
String |
环境id |
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 |
本次返回的列表长度 |
apis |
字典数据类型 |
本次返回的API列表 |
参数 |
类型 |
说明 |
---|---|---|
id |
String |
API编号 |
name |
String |
API名称 |
group_id |
String |
API所属分组的编号 |
group_name |
String |
API所属分组的名称 |
remark |
String |
API描述 |
run_env_name |
String |
发布的环境名 |
run_env_id |
String |
发布的环境id |
publish_id |
String |
发布记录的编号 |
auth_type |
String |
API的认证方式 |
req_uri |
String |
API的访问地址 |
响应消息样例:
{ "total": 1, "size": 1, "apis": [{ "id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9", "name": "查询分组列表", "remark": "查询分组列表", "group_id": "73c58022-f20d-495a-a188-85d718647f09", "group_name": "api_group_001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057", "auth_type": "APP", "req_uri": "/test" }] }
状态码
状态码 |
说明 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |