Help Center/ API Gateway/ API Reference (Paris Region)/ Shared Gateway APIs/ Binding Access Control Policies/ Querying the List of APIs Bound to an Access Control Policy
Updated on 2022-02-21 GMT+08:00

Querying the List of APIs Bound to an Access Control Policy

Function

This API is used to query the list of APIs bound to a specified access control policy.

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/acl-bindings/binded-apis[?page_no,page_size,acl_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: acl_id, api_id, api_name, group_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

acl_id

Yes

String

Access control policy ID

api_id

No

String

API ID

api_name

No

String

API name

group_id

No

String

API group 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 APIs to which the access control policy has been bound

size

Integer

Number of returned APIs

apis

Dictionary

API list

Table 4 Parameter description of apis

Parameter

Type

Description

api_id

String

API ID

api_name

String

API name

group_name

String

API group name

api_type

Integer

API type

api_remark

String

Description of the API

env_id

String

ID of the environment in which the access control policy takes effect

env_name

String

Name of the environment in which the access control policy takes effect

bind_id

String

Binding ID

bind_time

Timestamp

Time when the access control policy is bound to the API

publish_id

String

ID of the API publication record

Example response:

{
  "total": 1,
  "size": 1,
  "apis": [
    {
      "api_id": "aebacac6095942b4b2dd2b209bb7b9bc",
      "api_name": "aaa",
      "group_name": "test001",
      "api_type": 1,
      "api_remark": "aaa",
      "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
      "env_name": "RELEASE",
      "bind_id": "4ffc0da71ddd4c22add8ff801e19846c",
      "bind_time": "2018-07-27T11:27:10Z",
      "publish_id": "1bc8b2b741a04bd4af3ef9d7cd003104"
    }
  ]
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Server Internal Error