Updated on 2022-09-01 GMT+08:00

Querying the List of Signature Keys Bound to an API

Function

This API is used to query the list of signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

GET

/v1.0/apigw/sign-bindings/binded-signs[?page_no, page_size, api_id, sign_id, sign_name,env_id]

  • A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
  • Query conditions include: api_id, sign_id, sign_name, env_id, page_size, and page_no.

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

api_id

Yes

String

API ID

sign_id

No

String

Signature key ID

sign_name

No

String

Signature key name

env_id

No

String

Environment ID

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

total

Integer

Total number of signature keys that match the query conditions

size

Integer

Length of the returned signature key list

bindings

Dictionary

Signature key list

Table 4 Parameter description of bindings

Parameter

Type

Description

id

String

Binding ID

api_id

String

API ID

api_name

String

API name

api_remark

String

Description of the API

group_name

String

Name of the API group to which the API belongs

api_type

Integer

API type

sign_id

String

Signature key ID

sign_name

String

Signature key name

sign_key

String

Signature key

sign_secret

String

Signature secret

env_id

String

ID of the environment in which the API has been published

env_name

String

Name of the environment in which the API has been published

binding_time

Timestamp

Time when the signature key is bound to the API

publish_id

String

API publication ID

Example response:

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

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error