All Products
Search
Document Center

Describe an Plugin

Last Updated: Apr 24, 2019

Description

You can call this operation to query details of plug-ins based on the specified conditions.

  • You can specify PageNumber to obtain the results on a specific page.
  • You can query plug-ins by type.
  • You can query plug-ins by ID.
  • You can query plug-ins by name.
Name Type Required Description
Action String Yes The operation that you want to perform. Set this value to DescribePlugins.
PluginId String No The ID of a plug-in.
PluginName String No The name of the plug-in.
PluginType String No The type of the plug-in.
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 PluginAttrubite The returned plug-in information. It is an array that contains PluginAttribute data.

Examples

Sample request

  1. http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePlugins
  2. &PluginId=a96926e82f994915a8da40a119374537
  3. &PluginName=testPlugin
  4. &PluginType=cors
  5. &<Common request parameters>

Sample responses

XML format

  1. <DescribePluginsResponse>
  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. </DescribePluginsResponse>

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. }