Querying the List of APIs Bound to an App
Function
This API is used to query the list of APIs that have been bound to a specified app.
Only APIs that an app has been authorized to access in an environment can be queried.
URI
The following table lists the HTTP/HTTPS request method and URI of the API.
Request Method |
URI |
---|---|
GET |
/v1.0/apigw/app-auths/binded-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,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: app_id, api_id, api_name, group_id, group_name, env_id, page_size, and page_no.
The following table lists the parameters in the URI.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
app_id |
Yes |
String |
App ID |
api_id |
No |
String |
API ID |
api_name |
No |
String |
API name |
group_id |
No |
String |
API group ID |
group_name |
No |
String |
API group name |
env_id |
No |
String |
ID of the environment in which the app has been authorized |
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 |
Length of the returned API list |
auths |
Dictionary |
API list |
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 |
Name of the environment in which the app has been authorized to call the API |
env_id |
String |
ID of the environment |
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:
|
app_remark |
String |
App description |
app_type |
String |
App type |
publish_id |
String |
API publication ID |
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", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "app_remark": "App description", "app_type": "apig", "publish_id": "f500ba7e369b4b1ebae99aa9d114a17a" }] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
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