Queries the applications that you are authorized to manage based on query conditions.
Usage note
Supports filtering queries by application status.
QPS limit
A single user can perform a maximum of 30 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListAppInfo |
The operation that you want to perform. Set the value to ListAppInfo. |
Status | String | No | Normal |
The status of the application. After an application is created, it enters the Normal state. Valid values:
|
PageNo | Integer | No | 1 |
The number of the page to return. By default, pages start from page 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AppInfoList | Array of AppInfo |
The details of each application. |
|
AppId | String | app-**** |
The ID of the application. |
AppName | String | test |
The name of the application. |
CreationTime | String | 2019-03-01T08:00:00Z |
The time when the application was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Description | String | my first app. |
The description of the application. |
ModificationTime | String | 2019-03-01T09:00:00Z |
The last time when the application was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Status | String | Normal |
The status of the application. Valid values:
|
Type | String | System |
The type of the application. Valid values:
|
RequestId | String | 25818875-5F78-4A13-4D5C-D7393642**** |
The ID of the request. |
Total | Integer | 10 |
The total number of entries returned. |
Examples
Sample requests
http(s)://vod.cn-shanghai.aliyuncs.com/?Action=ListAppInfo
&Status=Normal
&PageNo=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListAppInfoResponse>
<Total>10</Total>
<RequestId>25818875-5F78-4A13-4D5C-D7393642****</RequestId>
<AppInfoList>
<Type>System</Type>
<Status>Normal</Status>
<CreationTime>2019-03-01T08:00:00Z</CreationTime>
<AppName>test</AppName>
<Description>my first app.</Description>
<AppId>app-****</AppId>
<ModificationTime>2019-03-01T09:00:00Z</ModificationTime>
</AppInfoList>
</ListAppInfoResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Total" : 10,
"RequestId" : "25818875-5F78-4A13-4D5C-D7393642****",
"AppInfoList" : [ {
"Type" : "System",
"Status" : "Normal",
"CreationTime" : "2019-03-01T08:00:00Z",
"AppName" : "test",
"Description" : "my first app.",
"AppId" : "app-****",
"ModificationTime" : "2019-03-01T09:00:00Z"
} ]
}
Error codes
For a list of error codes, visit the API Error Center.
Common errors
The following table describes the common errors that this operation can return.
Error code |
Error message |
HTTP status code |
Description |
---|---|---|---|
OperationDenied.NotOpenAppService |
The app service is not open. |
403 |
The error message returned because the multi-application service has not been activated. |