Help Center> API Gateway> API Reference> Shared Gateway APIs (for Existing Users)> App Authorization Management> Querying the List of Apps Bound to an API
View PDF

Querying the List of Apps Bound to an API

Function

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

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/app-auths/binded-apps[?page_size, page_no, api_id, app_name, app_id, 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, app_name, app_id, 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

No

String

API ID

app_name

No

string

App name

app_id

No

String

App ID

env_id

No

String

Environment ID

page_size

No

Integer

Number of records displayed on each page. The default value is 20.

page_no

No

Integer

Page number. The default value is 1.

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

total

Integer

Number of apps that match the query conditions

size

Integer

Length of the returned app list

auths

Dictionary

App list
Table 4 Parameter description of auths

Parameter

Type

Description

id

String

Authorization ID

api_id

String

API ID

api_name

String

API name

group_name

String

API group to which the API belongs

api_remark

String

Description of the API

api_type

Integer

API type

envname

String

Environment in which access to the API has been authorized to an app

auth_role

String

Authorizer

auth_time

String

Authorization time

appid

String

App ID

app_name

String

App name

app_creator

String

App creator, which can be:

  • USER: tenant
  • MARKET: API marketplace

publish_id

String

ID of the publication record

env_id

String

Environment ID

app_remark

String

App description

app_type

String

App type

Example response:

{
	"total": 1,
	"size": 1,
	"auths": [{
		"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a",
		"api_id": "6632a062-9dcf-4f18-9646-3cabb925a290",
		"api_name": "API_list_query",
		"group_name": "api_group_001",
		"api_type": 1,
		"api_remark": "API list query",
		"envname": "RELEASE",
		"auth_role": "PROVIDER",
		"auth_time": "2017-12-28T12:46:43Z",
		"appid": "14b399ac-967f-4115-bb62-c0346b4537e9",
		"app_name": "app_001",
		"app_creator": "USER",
                "publish_id": "fe9d8ea9f9424594abc3bbe8d861c0f0",
                "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
                "app_remark": "",
                "app_type": "apig"
	}]
}

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