Querying Authorized APIs of an App
Function
This API is used to query authorized APIs of an app.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/service/authorize/apps/{app_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
|
app_id |
Yes |
String |
App ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down. |
|
limit |
No |
Integer |
Maximum number of records that can be queried |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service. |
|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
|
Dlm-Type |
No |
String |
Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE. |
|
Content-Type |
Yes |
String |
Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total number of APIs bound to the app |
|
records |
Array of AppBindApiInfo objects |
List of APIs bound to the app |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
API ID. |
|
name |
String |
API name. |
|
description |
String |
API description, |
|
approval_time |
Long |
Review time. |
|
manager |
String |
Name of the API reviewer. |
|
deadline |
Long |
Expiry time of using the API, |
|
relationship_type |
String |
Binding relationship Enumerated values:
|
|
static_params |
Array of StaticParam objects |
List of static parameters. |
|
Parameter |
Type |
Description |
|---|---|---|
|
para_name |
String |
Name of a static parameter. |
|
para_value |
String |
Static parameter value. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
Query authorized APIs of an app.
/v1/0833a5737480d53b2f250010d01a7b88/service/authorize/apps/760715eb1bfce0c575abab3be3bd41e6
Example Responses
Status code: 200
Success
{
"total" : 1,
"records" : [ {
"id" : "2342936b7862317d0a81bfcfb657f243",
"name" : "testApi",
"description" : "test api",
"approval_time" : 1578897421000,
"manager" : "admin",
"deadline" : 1580452617000
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Success |
|
400 |
Bad request |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.