Querying the List of APIs Not Bound to an Access Control Policy
Function
This API is used to query the list of published APIs that have not been bound to a specified access control policy.
URI
The following table lists the HTTP/HTTPS request method and URI of the API.
Request Method |
URI |
---|---|
GET |
/v1.0/apigw/acl-bindings/unbinded-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, env_id, api_id, group_id, api_name, page_size, and page_no.
The following table lists the parameters in the URI.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
acl_id |
Yes |
String |
Access control policy ID |
env_id |
No |
String |
Environment ID |
group_id |
No |
String |
API group ID |
api_id |
No |
String |
API ID |
api_name |
No |
String |
API name |
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
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Number of APIs that match the query conditions |
size |
Integer |
Number of returned APIs |
apis |
Dictionary |
API list |
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 |
Opening status of the API |
remark |
String |
Description of the API |
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 |
ID of the API publication record |
acl_name |
String |
Name of the same type of access control policy that has been bound to the API |
req_uri |
String |
Access address |
auth_type |
String |
Security authentication mode |
Example response:
{ "total": 1, "size": 1, "apis": [ { "name": "bbbbb", "type": 1, "remark": "aaa", "group_id": "70f1b578da9b4dfe889b4c33d1b995c2", "id": "91c26288acea4448be205265d77dae22", "group_name": "test001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "a6e06a00c382436eb524fa2dd343cb6d", "req_uri": "/test", "auth_type": "NONE" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot