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

Querying the List of APIs Not Bound to a Signature Key

Function

This API is used to query the list of APIs that have not been bound to a specified signature key. Only published APIs will be displayed.

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/unbinded-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.

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.

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

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

apis

Dictionary

API list
Table 4 Parameter description of apis

Parameter

Type

Description

id

String

API ID

name

String

API name

type

Integer

API type

remark

String

Description of the API

group_id

String

ID of the API group to which the API belongs

group_name

String

Name of the API group to which the API belongs

run_env_name

String

Name of the environment in which the API has been published

run_env_id

String

ID of the environment in which the API has been published

publish_id

String

API publication record ID

signature_name

String

Name of the signature key bound to the API

auth_type

String

Security authentication mode

req_uri

String

Access address

Example response:

{
	"total": 2,
	"size": 2,
	"apis": [{
		"name": "bbb",
		"type": 1,
		"group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2",
		"id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b",
		"group_name": "asd",
		"run_env_name": "das",
		"run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215",
		"publish_id": "6dff16c4-813f-486a-bba4-fdad45a55a70",
		"auth_type": "NONE",
		"req_uri": "/test"
	},
	{
		"name": "aaa",
		"type": 1,
		"group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2",
		"id": "d85c502a-f916-47e8-bba0-50537a2d1af2",
		"group_name": "asd",
		"run_env_name": "das",
		"run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215",
		"publish_id": "dec83400-a0c6-4ea6-abfd-5bf237292f4d",
		"auth_type": "NONE",
		"req_uri": "/test"
	}]
}

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