DescribeAuthorizedApis Reference for APP API Access - API Gateway - Alibaba Cloud - API Gateway

Queries the authorized APIs of a specified APP.

Operation description

This operation is intended for API callers.
The specified application can call all APIs included in the responses.

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

get

*App

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	integer	Yes	The application ID, which is generated by the system and globally unique.	2386789
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.	D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	2
AuthorizedApis	object
AuthorizedApi	array<object>	The authorized API set.
	object
ApiId	string	The unique identifier of the API, which is automatically generated by the system.	baacc592e63a4cb6a41920d9d3f91f38
AuthorizationSource	string	The authorization source. Valid values: CONSOLE API	CONSOLE
AuthVaildTime	string	The expiration time of the authorization in UTC.	2018-10-05T16:00:00Z
Description	string	Authorization description	Queries weather information by region name.
GroupName	string	The name of the API group.	Weather
GroupId	string	The ID of the API group. This ID is generated by the system and globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
AuthorizedTime	string	The authorization time in UTC.	2016-07-21T06:17:20
Operator	string	The authorizer. Valid values: PROVIDER: API owner CONSUMER: API caller	PROVIDER
StageName	string	The name of the runtime environment. Valid values: RELEASE TEST: the test environment	RELEASE
ApiName	string	The name of the API	AreaWeather
RegionId	string	The region to which the API belongs.	cn-hangzhou

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "AuthorizedApis": {
    "AuthorizedApi": [
      {
        "ApiId": "baacc592e63a4cb6a41920d9d3f91f38",
        "AuthorizationSource": "CONSOLE",
        "AuthVaildTime": "2018-10-05T16:00:00Z",
        "Description": "Queries weather information by region name.",
        "GroupName": "Weather",
        "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
        "AuthorizedTime": "2016-07-21T06:17:20",
        "Operator": "PROVIDER",
        "StageName": "RELEASE",
        "ApiName": "AreaWeather",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.