All Products
Search

This Product

    Query the apps to be authorized

    Document Center
    Product Details

    Query the apps to be authorized

    Last Updated: Dec 19, 2017

    Description

    For querying the list of apps that support authorization, and extracting app information when open API users perform authorization.

    • This function is intended for API activators.
    • API users can use the AppId or their Alibaba Cloud accounts to query app information for authorization.
    • The interface can be called for at most 200 times every day in each region on a per-user basis.

    Request parameters

    Name Type Required? Description
    Action String Yes Operation interface name, which is a required parameter; value: DescribeApps.
    AppId Long No Unique ID of the app.
    AppOwner String No Alibaba Cloud account ID of the app owner. View Account Manager Page to get account ID.
    PageSize Integer No Number of lines per page set at paging query; maximum value: 100; default value: 10.
    PageNumber Integer No The page number specified for query; default value: 1; the starting number: 1.

    Return parameters

    Name Type Description
    RequestId String ID of the current request.
    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.
    Apps AppItem Returned app information, which is an array consisting of AppItem.

    Examples

    Request example

    1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApps
    2. &AppId=20112314518278
    3. &pageSize=10
    4. &pageNumber=1
    5. &<Public request parameters>

    Response example

    XML format

    1. <DescribeAppsResponse>
    2.     <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>
    3.       <TotalCount>1</TotalCount>
    4.     <PageSize>10</PageSize>
    5.     <PageNumber>1</PageNumber>
    6.     <Apps>
    7.         <AppItem>
    8.             <AppId>20112314518278</AppId>
    9.             <AppName>CreateApptest</AppName>
    10.             <Description>app test</Description>
    11.         </AppItem>
    12.     </Apps>
    13. </DescribeAppsResponse>

    JSON format

    1. {
    2.     "TotalCount":1,
    3.     "PageSize":10,
    4.     "PageNumber":1,
    5.     "RequestId":"8883AC74-259D-4C0B-99FC-0B7F9A588B2F",
    6.     "Apps":
    7.     {
    8.         "AppItem":
    9.         [
    10.             {
    11.                 "AppId":20112314518278,
    12.                 "AppName":"CreateApptest",
    13.                 "Description":"app test"                    }
    14.         ]
    15.     }
    16. }