All Products
Search
Document Center

API Gateway:DescribeAuthorizedApps

Last Updated:Apr 01, 2024

Queries the apps of an API.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeAuthorizedAppsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringNo

The ID of the API group. This ID is generated by the system and globally unique.

523e8dc7bbe04613b5b1d726c2a7889d
StageNamestringNo

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
RELEASE
ApiIdstringYes

The ID of the API. This ID is generated by the system and globally unique.

baacc592e63a4cb6a41920d9d3f91f38
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
AppIdlongNo

The ID of the app.

20112314518278
AppNamestringNo

The name of the app.

CreateApptest
AppOwnerIdlongNo

The Alibaba Cloud account of the app owner.

1546564

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

2
AuthorizedAppsobject []

The returned group set.

AppNamestring

The name of the app.

Weather
AuthorizationSourcestring

The authorization source. Valid values:

  • CONSOLE
  • API
CONSOLE
AuthVaildTimestring

The name of the app.

2018-10-05T16:00:00Z
Descriptionstring

The description of the authorization.

Queries weather based on the region name
AuthorizedTimestring

The authorization time (UTC).

2016-07-21T06:17:20Z
AppIdlong

The ID, which is generated by the system and globally unique.

2386789
StageNamestring

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
RELEASE
Operatorstring

The authorizer. Valid values:

  • PROVIDER: API owner
  • CONSUMER: API caller
PROVIDER

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",
        "Operator": "PROVIDER"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.