DescribeApps - API Gateway - Alibaba Cloud Documentation Center

Queries the apps of a user. App information is returned only to the app owner.

Operation description

This API is intended for API providers.
API providers can use the app IDs or their Apsara Stack tenant accounts to query app information.
Each provider can call this operation for a maximum of 200 times every day in a region.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeApps	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	long	No	The ID of the app.	20112314518278
AppOwner	long	No	The Alibaba Cloud account of the app owner. For more information, see Account Management.	1546564
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	1
Apps	object []	The returned app information. It is an array consisting of AppItem data.
AppName	string	The name of the app.	CreateApptest
Description	string	The description of the app.	App test
AppId	long	The ID of the app.	20112314518278

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "PageSize": 10,
  "TotalCount": 1,
  "Apps": {
    "AppItem": [
      {
        "AppName": "CreateApptest",
        "Description": "App test",
        "AppId": 20112314518278
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history