ListAppInfo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Call this operation to retrieve a list of application information based on specified query conditions.

Operation description

Usage notes

You can filter the query by application status.

QPS limits

The queries per second (QPS) limit for this operation is 30 for each user. If you exceed this limit, your API calls are throttled. This may affect your business operations. Plan your calls accordingly. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:ListAppInfo

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The status of the application. You can query applications in a specific status. After an application is created, its status is Normal by default. Valid values: Normal Disable	Normal
PageNo	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The default value is 10. The maximum value is 100.	10
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzko7fsuj****

Response elements

Element	Type	Description	Example
	object	The returned results.
Total	integer	The total number of entries.	10
RequestId	string	The request ID.	25818875-5F78-4A13-4D5C-D7393642****
AppInfoList	array<object>	The list of application information.
	object	The details of the application.
Type	string	The type of the application. Valid values: System Custom	System
Status	string	The status of the application. Valid values: Normal Disable	Normal
CreationTime	string	The time when the application was created. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2019-03-01T08:00:00Z
AppName	string	The name of the application.	test
Description	string	The description of the application.	my first app.
AppId	string	The ID of the application.	app-****
ModificationTime	string	The time when the application was last updated. The time is in UTC. The format is `yyyy-MM-ddTHH:mm:ssZ`.	2019-03-01T09:00:00Z
RegionId	string	The region.	cn-shanghai
ResourceGroupId	string	The ID of the resource group.	rg-aekzko7fsuj****

Examples

Success response

JSON format

{
  "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",
      "RegionId": "cn-shanghai",
      "ResourceGroupId": "rg-aekzko7fsuj****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.