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
http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePlugins&PluginId=a96926e82f994915a8da40a119374537&PluginName=testPlugin&PluginType=cors&<Common request parameters>
Sample responses
XML format
<DescribePluginsResponse><RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId><TotalCount>20</TotalCount><PageSize>10</PageSize><PageNumber>1</PageNumber><Plugins><PluginAttribute><PluginId>9a3f1a5279434f2ba74ccd91c295af9f</PluginId><PluginName>firstPlugin</PluginName><RegionId>cn-qingdao</RegionId><PluginType>trafficControl</PluginType><PluginData>{"unit":"MINUTE","apiDefault":20}</PluginData><Description>Throttling</Description><CreatedTime>2019-01-11T09:29:58Z</CreatedTime><ModifiedTime>2019-01-11T09:29:58Z</ModifiedTime></PluginAttribute></Plugins></DescribePluginsResponse>
JSON format
{"RequestId": "46373DC4-19F1-4DC8-8C31-1107289BB5E0","TotalCount": "1","PageNumber": "1","PageSize": "10","Plugins": {"PluginAttribute": [{"PluginId":"9a3f1a5279434f2ba74ccd91c295af9f","PluginName":"firstPlugin","RegionId":"cn-qingdao","PluginType":"trafficControl","PluginData":"{\"unit\":\"MINUTE\",\"apiDefault\":20}","Description": "Throttling","CreatedTime":"2019-01-11T09:29:58Z","ModifiedTime":"2019-01-11T09:29:58Z"}]},}