All Products
Search

This Product

    Describe Plugins by API

    Document Center
    Product Details

    Describe Plugins by API

    Last Updated: Apr 24, 2019

    Description

    You can call this operation to check the plug-ins bound to a specified API that is running in a specified environment.

    • This operation is intended for API providers.
    • This operation is used to check the plug-ins bound to the specified API that is running in a specified environment.
    • You can specify PageNumber to obtain the results on a specific page.

    Request parameters

    Name Type Required Description
    Action String Yes The operation that you want to perform. Set this value to DescribePluginsByApi.
    ApiId String Yes The ID of the API for which you want to check the bound plug-ins.
    GroupId String Yes The ID of the API group to which the specified API belongs.
    StageName String Yes The name of the runtime environment. Valid values:
    • RELEASE: indicates the release environment.
    • PRE: indicates the pre-release environment.
    • TEST: indicates the test environment.
    PageNumber Integer No The page number that you want to query. Default value: 1. The starting number is 1.
    PageSize Integer No The number of rows per page. Maximum value: 100. Default value: 10.

    Response parameters

    Name Type Description
    RequestId String The request ID.
    TotalCount Integer The total number of rows.
    PageNumber Integer The specified page number.
    PageSize Integer The specified number of rows returned per page.
    Plugins PluginAttribute The returned plug-in information. It is an array that contains PluginAttribute data.

    Examples

    Sample request

    1. http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePluginsByApi
    2. &ApiId=93f4ead4080c4b2da70b7f81f50ae459
    3. &GroupId=3c7a38392e764718ad7673e7b7f535d4
    4. &StageName=RELEASE
    5. &<Common request parameters>

    Sample responses

    XML format

    1. <DescribePluginsByApiResponse>
    2.    <RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId>
    3.    <TotalCount>20</TotalCount>
    4.    <PageSize>10</PageSize>
    5.    <PageNumber>1</PageNumber>
    6.    <Plugins>
    7.       <PluginAttribute>
    8.           <PluginId>9a3f1a5279434f2ba74ccd91c295af9f</PluginId>
    9.           <PluginName>firstPlugin</PluginName>
    10.           <RegionId>cn-qingdao</RegionId>
    11.           <PluginType>trafficControl</PluginType>
    12.           <PluginData>{"unit":"MINUTE","apiDefault":20}</PluginData>
    13.           <Description>Throttling</Description>
    14.           <CreatedTime>2019-01-11T09:29:58Z</CreatedTime>
    15.           <ModifiedTime>2019-01-11T09:29:58Z</ModifiedTime>
    16.       </PluginAttribute>
    17.    </Plugins>
    18. </DescribePluginsByApiResponse>

    JSON format

    1. {
    2.    "RequestId": "46373DC4-19F1-4DC8-8C31-1107289BB5E0",
    3.    "TotalCount": "1",
    4.    "PageNumber": "1",
    5.    "PageSize": "10",
    6.    "Plugins": {
    7.         "PluginAttribute": [{
    8.             "PluginId":"9a3f1a5279434f2ba74ccd91c295af9f",
    9.             "PluginName":"firstPlugin",
    10.             "RegionId":"cn-qingdao",
    11.             "PluginType":"trafficControl",
    12.             "PluginData":"{\"unit\":\"MINUTE\",\"apiDefault\":20}",
    13.             "Description": "Throttling",
    14.             "CreatedTime":"2019-01-11T09:29:58Z",
    15.             "ModifiedTime":"2019-01-11T09:29:58Z"
    16.         }]
    17.     },
    18. }