Help Center/ ROMA Connect/ API Reference (ME-Abu Dhabi Region)/ APIC APIs/ Binding/Unbinding Access Control Policies/ Querying APIs Not Bound with an Access Control Policy
Updated on 2022-12-05 GMT+08:00
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.

URI

GET /v2/{project_id}/apic/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 the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Long

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

Default: 0

limit

No

Integer

Number of items displayed on each page.

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.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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

auth_type

String

Security authentication mode.

run_env_name

String

Name of the environment in which the API has been published.

group_name

String

API group name.

publish_id

String

Publication record ID.

group_id

String

ID of the API group to which the API belongs.

name

String

API name.

remark

String

API description.

run_env_id

String

ID of the environment in which the API has been published.

id

String

API ID.

req_uri

String

API request address.

type

Integer

API type.

acl_name

String

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

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

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.