Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> Binding Signature Keys> Querying the List of APIs Bound to a Signature Key
View PDF

Querying the List of APIs Bound to a Signature Key

Function

This API is used to query the list of APIs that have been bound to a specified signature key.

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/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_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: sign_id, env_id, api_id, api_name, group_id, page_size, and page_no.

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by the administrator on the My Credentials page.

instance_id

Yes

String

Instance ID, which can be obtained from the dedicated gateway information on the API Gateway console.

sign_id

Yes

String

Signature key ID

env_id

No

String

Environment ID

api_id

No

String

API ID

api_name

No

String

API name

group_id

No

String

API group ID

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

total

Integer

Total number of APIs that match the query conditions

size

Integer

Length of the returned API list

bindings

Dictionary

API 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
Parent topic: Binding Signature Keys