DescribeAuthorizedApis - API Gateway - Alibaba Cloud Documentation Center

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.

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:DescribeAuthorizedApis	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	long	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 parameters

Parameter	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 []	The authorized API set.
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 based on the 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

Sample success responses

JSONformat

{
  "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 based on the region name\n",
        "GroupName": "Weather",
        "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
        "AuthorizedTime": "2016-07-21T06:17:20",
        "Operator": "PROVIDER",
        "StageName": "RELEASE",
        "ApiName": "AreaWeather",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history