All Products
Search

This Product

    API Gateway:DescribeApp

    Document Center

    API Gateway:DescribeApp

    Last Updated:Mar 30, 2026

    This operation queries the list of Apps available for authorization and fetches App information for developers during authorization operations.

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

    get

    *App

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppId

    integer

    No

    The App ID. The system generates this globally unique ID.

    110843374

    Response elements

    Element

    Type

    Description

    Example

    object

    AppName

    string

    App name

    CreateApptest
    RequestId

    string

    The ID of this request.

    DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB
    ModifiedTime

    string

    App modification time

    2019-01-29T09:33:01Z
    Description

    string

    App description

    2021year10month15day10:20:27Estimate
    AppId

    integer

    The unique ID of the App

    110843374
    CreatedTime

    string

    Creation time

    2019-01-29T09:33:01Z
    Extend

    string

    Extension information

    110243810311
    Disabled

    boolean

    Examples

    Success response

    JSON format

    {
  "AppName": "CreateApptest",
  "RequestId": "DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB",
  "ModifiedTime": "2019-01-29T09:33:01Z",
  "Description": "2021year10month15day10:20:27Estimate",
  "AppId": 110843374,
  "CreatedTime": "2019-01-29T09:33:01Z",
  "Extend": "110243810311",
  "Disabled": false
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.