Query applications by using DescribeAppAttributes - API Gateway

Query the list of applications and their basic information.

Operation description

This feature is intended for users who call APIs.
The AppId parameter is optional.

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

apigateway:DescribeAppAttributes

get

*App

acs:apigateway:{#regionId}:{#accountId}:app/*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	integer	No	The ID of the application.	20112314518278
AppName	string	No	The name of the application.	testApp
PageNumber	integer	No	Specify the page number to query. The default value is 1, and the starting value is 1.	1
PageSize	integer	No	Specify the number of rows per page for paged query. The maximum value is 100, and the default value is 10.	10
AppCode	string	No	The AppCode encoding of the application.	23552160
AppKey	string	No	The application key, used when calling APIs.	203708622
Sort	string	No	Sort order. The default value is desc. Options are asc and desc. asc: Sort by modification time in ascending order. desc: Sort by modification time in descending order.	desc
EnableTagAuth	boolean	No	Enable tag validation.	true
Tag	array<object>	No	Specify object tags that apply to the rule. You can set multiple tags.	Key， Value
	object	No	Specify object tags that apply to the rule. You can set multiple tags.
Key	string	Yes	The tag value. The value range of n is `[1, 20]`	env
Value	string	No	The tag key. The value range of n is `[1, 20]`	' '
Extend	string	No	Extension information.	110243810311

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The returned page number.	1
RequestId	string	The request ID.	8883AC74-259D-4C0B-99FC-0B7F9A588B2F
PageSize	integer	The returned number of entries per page.	10
TotalCount	integer	The total number of entries in the returned result.	1
Apps	object
AppAttribute	array<object>	An array of AppAttribute objects that returns application information.
	array<object>
AppName	string	The name of the application.	CreateApptest
ModifiedTime	string	Modification time (Greenwich Mean Time).	2016-07-31T04:10:19Z
Description	string	The description of the application.	App test
CreatedTime	string	Creation time (Greenwich Mean Time).	2016-07-31T04:10:19Z
AppId	integer	The application ID.	20112314518278
Extend	string	Extension information.	110461946884
Disabled	boolean
Tags	object
TagInfo	array<object>	List of tags.
	object
Key	string	The tag key.	appid
Value	string	The tag value.	123

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "8883AC74-259D-4C0B-99FC-0B7F9A588B2F",
  "PageSize": 10,
  "TotalCount": 1,
  "Apps": {
    "AppAttribute": [
      {
        "AppName": "CreateApptest",
        "ModifiedTime": "2016-07-31T04:10:19Z",
        "Description": "App test",
        "CreatedTime": "2016-07-31T04:10:19Z",
        "AppId": 20112314518278,
        "Extend": "110461946884",
        "Disabled": false,
        "Tags": {
          "TagInfo": [
            {
              "Key": "appid",
              "Value": "123"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.