All Products
Search
Document Center

API for binding under query Plug-ins

Last Updated: Apr 24, 2019

Description

You can call this operation to check the APIs to which a specified plug-in is bound.

  • This operation is intended for API providers.
  • This operation is used to check the APIs to which a specified plug-in is bound.
  • You can specify PageNumber to obtain the results on a specific page.
  • The returned APIs may have been unpublished from the corresponding runtime environments.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform. Set this value to DescribePluginApis.
PluginId String Yes The ID of the plug-in for which you want to check the bound APIs.
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.
ApiSummarys ApiPluginSummary The returned API definition information. It is an array that contains ApiPluginSummary data.

Examples

Sample request

  1. http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePluginApis
  2. &PluginId=a96926e82f994915a8da40a119374537
  3. &<Common request parameters>

Sample responses

XML format

  1. <DescribePluginApisResponse>
  2. <RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId>
  3. <TotalCount>20</TotalCount>
  4. <PageSize>10</PageSize>
  5. <PageNumber>1</PageNumber>
  6. <ApiSummarys>
  7. <ApiPluginSummary>
  8. <ApiId>9a3f1a5279434f2ba74ccd91c295af9f</ApiId>
  9. <ApiName>firstAPI</ApiName>
  10. <RegionId>cn-qingdao</RegionId>
  11. <StageName>RELEASE</StageName>
  12. <GroupId>46c79e78dfab4521a5f737faa805c4e1</GroupId>
  13. <GroupName>firstGroup</GroupName>
  14. <Description>Description</Description>
  15. </ApiPluginSummary>
  16. </ApiSummarys>
  17. </DescribePluginApisResponse>

JSON format

  1. {
  2. "RequestId": "2DF14872-77CE-43A4-AB47-C4F128E5AA31",
  3. "TotalCount": "1",
  4. "PageNumber": "1",
  5. "PageSize": "10",
  6. "ApiSummarys": {
  7. "ApiPluginSummary": [{
  8. "ApiId":"9a3f1a5279434f2ba74ccd91c295af9f",
  9. "ApiName":"firstAPI",
  10. "RegionId":"cn-qingdao",
  11. "StageName":"RELEASE",
  12. "GroupId":"46c79e78dfab4521a5f737faa805c4e1",
  13. "GroupName": "firstGroup",
  14. "Description":"Description"
  15. }]
  16. },
  17. }