Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> Signature Key Management> Querying the Signature Key List
View PDF

Querying the Signature Key List

Function

This API is used to query the information about all signature keys.

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}/signs[?page_size, page_no, id, name]
  • A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
  • Query conditions include: id and name.

Request

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.

id

No

String

Signature key ID

name

No

String

Signature key name

precise_search

No

String

Parameter name (name) for exact matching

Response

Table 3 Parameter description

Parameter

Type

Description

total

Integer

Number of signature keys that match the query conditions

size

Integer

Length of the returned signature key list

signs

Dictionary

Signature key list
Table 4 Parameter description of signs

Parameter

Type

Description

id

String

Signature key ID

name

String

Signature key name

sign_key

String

Signature key

sign_secret

String

Signature secret

create_time

Timestamp

Time when the signature key is created

update_time

Timestamp

Time when the signature key was last updated

bind_num

Integer

Number of APIs to which the signature key has been bound

Example response:

{
	"total": 2,
	"size": 2,
	"signs": [{
		"name": "signature01",
		"sign_key": "abcd_1234",
		"sign_secret": "******",
		"id": "3a793b65a9034bdfae08924f149bfb4a",
		"create_time": "2018-02-06T12:17:36Z",
		"update_time": "2018-02-07T02:00:27.964766Z",
                "bind_num":1
	},
	{
		"name": "sada",
		"sign_key": "asdasdasdasda",
		"sign_secret": "******",
		"id": "51ce490901f4411fa54eb06d33bd7218",
		"create_time": "2018-02-06T11:53:08Z",
		"update_time": "2018-02-06T11:53:08Z",
                "bind_num":1
	}]
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error
Parent topic: Signature Key Management