Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Binding/Unbinding Access Control Policies/ Querying APIs Not Bound with an Access Control Policy
Updated on 2024-11-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying APIs Not Bound with an Access Control Policy

Function

This API is used to query the published APIs to which an access control policy has not been bound.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded-apis

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

Minimum: 1

Maximum: 500

Default: 20

acl_id

Yes

String

Access control policy ID.

api_id

No

String

API ID.

api_name

No

String

API name.

env_id

No

String

Environment ID.

group_id

No

String

API group ID.

tags

No

String

API tag. Multiple API tags can be specified. The relationship between multiple parameter values is OR. If this parameter is not specified, no filtering tag is specified. If this parameter is set to #no_tags#, APIs without tags are filtered.

Minimum: 0

Maximum: 128

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

apis

Array of UnbindApiForAcl objects

API list.
Table 5 UnbindApiForAcl

Parameter

Type

Description

id

String

API ID.

name

String

API name.

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.

type

Integer

API visibility.

remark

String

API description.

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.

acl_name

String

Name of the same type of access control policy bound to the API.

req_uri

String

API request address.

auth_type

String

API authentication mode.

req_method

String

Request method.

tags

Array of strings

Tags bound to the API. The default quota is 10. You can contact technical support to adjust the quota.

Minimum: 1

Maximum: 128

Array Length: 0 - 10

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "size" : 1,
  "apis" : [ {
    "name" : "Api_mock",
    "type" : 1,
    "remark" : "Mock backend API",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
    "group_name" : "api_group_001",
    "run_env_name" : "RELEASE",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
    "req_uri" : "/test/mock",
    "auth_type" : "IAM"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3006",
  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.