DescribeAuthorizedApps - API Gateway - Alibaba Cloud Documentation Center

Queries the current apps.

Operation description

This operation is intended for API providers.
All applications included in the responses have access to the specified API.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:DescribeAuthorizedApps	get	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the API group. This ID is generated by the system and globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
StageName	string	No	The environment. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE
ApiId	string	Yes	The ID of the API. This ID is generated by the system and globally unique.	baacc592e63a4cb6a41920d9d3f91f38
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
AppId	long	No	The ID of the app.	20112314518278
AppName	string	No	The name of the app.	CreateApptest
AppOwnerId	long	No	The Alibaba Cloud account of the app owner.	1546564

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
AuthorizedApps	array<object>	The authorized applications.
AuthorizedApp	object
AppName	string	The application name.	Weather
AuthorizationSource	string	The authorization source. Valid values: CONSOLE API	CONSOLE
AuthVaildTime	string	The application name.	2018-10-05T16:00:00Z
Description	string	The authorization description.	Queries weather based on the region name
AuthorizedTime	string	The authorization time (UTC).	2016-07-21T06:17:20Z
AppId	long	The application ID, which is generated by the system and globally unique.	2386789
StageName	string	The environment to which the API is published. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE
StageAlias	string	The environment alias.	Production
Operator	string	The authorizer. Valid values: PROVIDER: API owner CONSUMER: API caller	PROVIDER
AppDescription	string	The application description.	Production application
Tag	array<object>	The key of the tag.
TagInfo	object
Key	string	The tag key.	DEV
Value	string	The tag value.	240

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "AuthorizedApps": {
    "AuthorizedApp": [
      {
        "AppName": "Weather\n",
        "AuthorizationSource": "CONSOLE",
        "AuthVaildTime": "2018-10-05T16:00:00Z",
        "Description": "Queries weather based on the region name\n",
        "AuthorizedTime": "2016-07-21T06:17:20Z",
        "AppId": 2386789,
        "StageName": "RELEASE",
        "StageAlias": "Production\n",
        "Operator": "PROVIDER",
        "AppDescription": "Production application\n",
        "Tag": {
          "TagInfo": [
            {
              "Key": "DEV",
              "Value": 240
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details
2024-06-13	The response structure of the API has changed	View Change Details
2024-04-18	The response structure of the API has changed	View Change Details
2024-03-21	The response structure of the API has changed	View Change Details