All Products
Search
Document Center

ApsaraVideo VOD:ListAppInfo

Last Updated:Sep 26, 2024

Queries the applications that you are authorized to manage based on query conditions.

Operation description

Usage notes

You can query applications based on states.

QPS limit

You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits on API operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:ListAppInfolist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StatusstringNo

The status of the application. You can specify the status of the applications that you want to query. After an application is created, it enters the Normal state. Valid values:

  • Normal
  • Disable
Normal
PageNointegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
ResourceGroupIdstringNo

The ID of the resource group.

rg-aekzko7fsuj****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Totalinteger

The total number of entries returned.

10
RequestIdstring

The ID of the request.

25818875-5F78-4A13-4D5C-D7393642****
AppInfoListarray<object>

The details of applications.

AppInfoobject

The details of the application.

Typestring

The type of the application. Valid values:

  • System
  • Custom
System
Statusstring

The status of the application. Valid values:

  • Normal
  • Disable
Normal
CreationTimestring

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.

2019-03-01T08:00:00Z
AppNamestring

The name of the application.

test
Descriptionstring

The description of the application.

my first app.
AppIdstring

The ID of the application.

app-****
ModificationTimestring

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.

2019-03-01T09:00:00Z
ResourceGroupIdstring

The ID of the resource group.

rg-aekzko7fsuj****

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-02The response structure of the API has changedView Change Details
2024-07-31The request parameters of the API has changed. The response structure of the API has changedView Change Details