DescribeApps API Overview for App Retrieval - API Gateway

Operation description

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

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:DescribeApps

get

*App

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	integer	No	The ID of the app.	20112314518278
AppOwner	integer	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 elements

Element	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
AppItem	array<object>	The returned app information. It is an array consisting of AppItem data.
	object
AppName	string	The name of the app.	CreateApptest
Description	string	The description of the app.	App test
AppId	integer	The ID of the app.	20112314518278

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.