查看签名密钥绑定的API列表
功能介绍
查询某个签名密钥上已经绑定的API列表。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
| 请求方法 | URI |
|---|---|
| GET | /v1.0/apigw/sign-bindings/binded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_id] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_id、page_size、page_no。
URI中的参数说明如下表所示。
| 名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| sign_id | 是 | String | 签名密钥编号 |
| env_id | 否 | String | 环境编号 |
| api_id | 否 | String | API编号 |
| api_name | 否 | String | API名称 |
| group_id | 否 | String | API分组编号 |
请求消息
无
响应消息
| 名称 | 类型 | 说明 |
|---|---|---|
| total | Integer | 本次查询满足条件的API总数 |
| size | Integer | 本次查询返回的API列表长度 |
| bindings | 字典数据类型 | 本次查询返回的API列表 |
| 参数 | 类型 | 说明 |
|---|---|---|
| id | String | 绑定关系的ID |
| api_id | String | API编号 |
| api_name | String | API名称 |
| api_remark | String | API描述 |
| group_name | String | API所属分组的名称 |
| api_type | Integer | API类型 |
| sign_id | String | 签名密钥的编号 |
| sign_name | String | 签名密钥的名称 |
| sign_key | String | 签名密钥的key |
| sign_secret | String | 签名密钥的密钥 |
| env_id | String | API所属环境的编号 |
| env_name | String | API所属环境的名称 |
| binding_time | Timestamp | 绑定时间 |
| publish_id | String | API的发布编号 |
响应消息样例:
{
"total": 2,
"size": 2,
"bindings": [
{
"id": "4588ec6f5dab4f67b298dc693f58029e",
"api_id": "d85c502a-f916-47e8-bba0-50537a2d1af2",
"api_name": "aaa",
"api_remark": "",
"group_name": "asd",
"api_type": 1,
"sign_id": "3a793b65a9034bdfae08924f149bfb4a",
"sign_name": "signature01",
"sign_key": "abcd_1234",
"sign_secret": "******",
"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name": "RELEASE",
"binding_time": "2018-02-07T07:08:51Z",
"publish_id": "3a793b65a9034bdfae08924f149bfsda"
},
{
"id": "d8426fb090e442c4a56a35e451bea085",
"api_id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b",
"api_name": "bbb",
"api_remark": "",
"group_name": "asd",
"api_type": 1,
"sign_id": "3a793b65a9034bdfae08924f149bfb4a",
"sign_name": "signature01",
"sign_key": "abcd_1234",
"sign_secret": "******",
"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name": "RELEASE",
"binding_time": "2018-02-07T03:17:26Z",
"publish_id": "3a793b65a9034bdfae08924f149bfsda"
}
]
} 状态码
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |