Description
For querying the authorized API list of a specified app, that is, the APIs that a specified app can call.
- This API is intended for API users.
- Apps can call all APIs returned by the query results.
Request parameters
Name | Type | Required? | Description |
---|---|---|---|
Action | String | Yes | Interface name, which is a required parameter; value: DescribeAuthorizedApis. |
AppId | Long | Yes | app ID, which is generated by the system and globally unique. |
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. |
PageSize | Integer | Specified total number of results returned per page. |
PageNumber | Integer | Page number specified to be returned. |
AuthorizedApis | AuthorizedApi | Authorized API set. |
Examples
Request example
http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeAuthorizedApis
&AppId=2386789
&<Public request parameters>
Response example
XML
format
<DescribeAuthorizedApisResponse>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
<AuthorizedApis>
<AuthorizedApi>
<RegionId>cn-hangzhou</RegionId>
<GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
<GroupName>Weather</GroupName>
<StageName>RELEASE</StageName>
<Operator>PROVIDER</Operator>
<ApiId>baacc592e63a4cb6a41920d9d3f91f38</ApiId>
<ApiName>AreaWeather</ApiName>
<AuthorizationSource>CONSOLE</AuthorizationSource>
<Description> Query weather conditions by region name</Description>
<AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
</AuthorizedApi>
<AuthorizedApi>
<RegionId>cn-hangzhou</RegionId>
<GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
<GroupName>Weather</GroupName>
<StageName>RELEASE</StageName>
<Operator>CONSUMER</Operator>
<ApiId>baacc592e63a4cb6a41920d9d3f89g76</ApiId>
<ApiName>Area</ApiName>
<AuthorizationSource>API</AuthorizationSource>
<Description> Query a region</Description>
<AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
</AuthorizedApi>
</AuthorizedApis>
</DescribeAuthorizedApisResponse>
JSON
format
{
"PageNumber": "1",
"TotalCount": "2",
"PageSize": "10",
"RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
"AuthorizedApis": {
"AuthorizedApi": [
{
"RegionId": "cn-hangzhou",
"GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
"GroupName": "Weather",
"StageName": "RELEASE",
"Operator": "Provider",
"ApiId": "baacc592e63a4cb6a41920d9d3f91f38",
"ApiName": "AreaWeather",
"AuthorizationSource": "CONSOLE",
"Description": " Query weather conditions by region name",
"AuthorizedTime": "2016-07-21T06:17:20Z"
},
{
"RegionId": "cn-hangzhou",
"GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
"GroupName": "Weather",
"StageName": "RELEASE",
"Operator": "CONSUMER",
"ApiId": "baacc592e63a4cb6a41920d9d3f89g76",
"ApiName": "Area",
"AuthorizationSource": "API",
"Description": " Query a region",
"AuthorizedTime": "2016-07-21T06:17:20Z"
}
]
}
}