Description
For querying the list of apps that can access an API currently.
- This API is intended for API providers.
- The interface is used to query the list of apps that can access a specified API currently.
- All apps included in the returned query results can access a specified API.
Request parameters
Name | Type | Required? | Description |
---|---|---|---|
Action | String | Yes | Interface name, which is a required parameter; value: DescribeAuthorizedApps. |
GroupId | String | No | API group ID, which is generated by the system and globally unique. |
ApiId | String | Yes | App ID, which is generated by the system and globally unique. |
StageName | String | No | Stage name; values:
|
PageNumber | Integer | No | The page number specified for query; default value: 1; the starting number: 1. |
PageSize | Integer | No | Number of lines per page set at paging query; maximum value: 100; default value: 10. |
Return parameters
Name | Type | Description |
---|---|---|
RequestId | String | Unique request ID. |
TotalCount | Integer | Total number of returned results. |
PageNumber | Integer | Page number specified to be returned. |
PageSize | Integer | Specified total number of results returned per page. |
AuthorizedApps | AuthorizedApp | Returned group set. |
Examples
Request example
http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeAuthorizedApps
&ApiId=baacc592e63a4cb6a41920d9d3f91f38
&<Public request parameters>
Response example
XML
format
<DescribeAuthorizedAppsResponse>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
<AuthorizedApps>
<AuthorizedApp>
<StageName>RELEASE</StageName>
<AppId>2386789</AppId>
<AppName> Weather app</AppName>
<Operator>PROVIDER</Operator>
<AuthorizationSource>CONSOLE</AuthorizationSource>
<Description> Query weather conditions by region name</Description>
<AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
</AuthorizedApp>
<AuthorizedApp>
<StageName>TEST</StageName>
<AppId>2386789</AppId>
<AppName> Weather app</AppName>
<Operator>CONSUMER</Operator>
<AuthorizationSource>API</AuthorizationSource>
<Description> Query weather conditions by region name</Description>
<AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
</AuthorizedApp>
</AuthorizedApps>
</DescribeAuthorizedAppsResponse>
JSON
format
{
"TotalCount": "2",
"PageNumber": "1",
"PageSize": "10",
"RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
"AuthorizedApps": {
"AuthorizedApp": [
{
"StageName": "RELEASE",
"AppId": 2386789,
"AppName": " Weather app",
"Operator": "PROVIDER",
"AuthorizationSource": "CONSOLE",
"Description": " Query weather conditions by region name",
"AuthorizedTime": "2016-07-21T06:17:20Z"
},
{
"StageName": "TEST",
"AppId": 2386789,
"AppName": " Weather app",
"Operator": "CONSUMER",
"AuthorizationSource": "API",
"Description": " Query weather conditions by region name",
"AuthorizedTime": "2016-07-21T06:17:20Z"
}
]
}
}