DescribeAppAttributes - API Gateway - Alibaba Cloud Documentation Center

Queries a list of applications and their basic information.

Operation description

This is an API-only feature.
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	The page number to query. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The maximum value is 100. The default value is 10.	10
AppCode	string	No	The AppCode of the application.	23552160
AppKey	string	No	The key of the application. This key is used to call the API.	203708622
Sort	string	No	The sorting order. The default value is desc. Valid values: asc: sorts the results in ascending order based on the modification time. desc: sorts the results in descending order based on the modification time.	desc
EnableTagAuth	boolean	No	Specifies whether to enable tag authentication.	true
Tag	array<object>	No	The tags used to filter applications. You can specify up to 20 tags.	Key， Value
	object	No	The tags used to filter applications. You can specify multiple tags.
Key	string	Yes	The key of the tag. The value of n ranges from 1 to 20.	env
Value	string	No	Specifies the tag key. The value of n must be in the range `[1, 20]`.	' '
Extend	string	No	Extended 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 number of entries returned on each page.	10
TotalCount	integer	The total number of entries.	1
Apps	object
AppAttribute	array<object>	An array of AppAttribute objects that contain information about the applications.
	array<object>
AppName	string	The name of the application.	CreateApptest
ModifiedTime	string	The time when the application was last modified. The time is in GMT.	2016-07-31T04:10:19Z
Description	string	The description of the application.	App test
CreatedTime	string	The time when the application was created. The time is in GMT.	2016-07-31T04:10:19Z
AppId	integer	The ID of the application.	20112314518278
Extend	string	Extended information.	110461946884
Disabled	boolean
Tags	object
TagInfo	array<object>	The 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": true,
        "Tags": {
          "TagInfo": [
            {
              "Key": "appid",
              "Value": "123"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.