查看签名密钥未绑定的API列表
功能介绍
查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。
URI
HTTP/HTTPS请求方法以及URI如表3-73所示。
请求方法 |
URI |
---|---|
GET |
/v1.0/apigw/sign-bindings/unbinded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_id] |
![](https://support.huaweicloud.com/intl/zh-cn/api-apig/public_sys-resources/note_3.0-zh-cn.png)
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_id、page_size、page_no。
请求消息
名称 |
是否必选 |
类型 |
说明 |
---|---|---|---|
sign_id |
是 |
String |
安全密钥编号 |
env_id |
否 |
String |
环境编号 |
api_id |
否 |
String |
API编号 |
api_name |
否 |
String |
API名称 |
group_id |
否 |
String |
API分组编号 |
响应消息
名称 |
类型 |
说明 |
---|---|---|
total |
Integer |
满足查询条件的API的总个数 |
size |
Integer |
本次查询返回的API列表长度 |
apis |
字典数据类型 |
本次查询返回的API列表 |
参数 |
类型 |
说明 |
---|---|---|
id |
String |
API编号 |
name |
String |
API名称 |
type |
Integer |
API类型 |
remark |
String |
API描述 |
group_id |
String |
API所属分组的编号 |
group_name |
String |
API所属分组的名称 |
run_env_name |
String |
发布的环境名 |
run_env_id |
String |
发布的环境id |
publish_id |
String |
API的发布记录编号 |
signature_name |
String |
已绑定的签名密钥名称 |
auth_type |
String |
API的认证方式 |
req_uri |
String |
API的访问地址 |
响应消息样例:
{ "total": 2, "size": 2, "apis": [{ "name": "bbb", "type": 1, "group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2", "id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b", "group_name": "asd", "run_env_name": "das", "run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215", "publish_id": "6dff16c4-813f-486a-bba4-fdad45a55a70", "auth_type": "NONE", "req_uri": "/test" }, { "name": "aaa", "type": 1, "group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2", "id": "d85c502a-f916-47e8-bba0-50537a2d1af2", "group_name": "asd", "run_env_name": "das", "run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215", "publish_id": "dec83400-a0c6-4ea6-abfd-5bf237292f4d", "auth_type": "NONE", "req_uri": "/test" }] }
状态码
状态码 |
说明 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |