API网关 APIGAPI网关 APIG

更新时间:2021/09/29 GMT+08:00
分享

查看API绑定的签名密钥列表

功能介绍

查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

GET

/v1/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-signs[?page_no, page_size, api_id, sign_id, sign_name,env_id]

  • 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
  • 查询条件可为以下字段以及对应的值:api_id、sign_id、sign_name、env_id、page_size、page_no。

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

project_id

String

项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。

instance_id

String

实例ID,可从API网关控制台的专享版实例信息中获取。

api_id

String

API的编号

sign_id

String

签名密钥的编号

sign_name

String

签名密钥的名称

env_id

String

环境编号

请求消息

响应消息

表3 参数说明

名称

类型

说明

total

Integer

本次查询满足条件的签名密钥总数

size

Integer

本次查询返回的签名密钥列表长度

bindings

字典数据类型

本次查询返回的签名密钥列表

表4 bindings参数说明

名称

类型

说明

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"
    }
  ]
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

分享:

    相关文档

    相关产品