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:
|
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
http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePluginsByApi
&ApiId=93f4ead4080c4b2da70b7f81f50ae459
&GroupId=3c7a38392e764718ad7673e7b7f535d4
&StageName=RELEASE
&<Common request parameters>
Sample responses
XML
format
<DescribePluginsByApiResponse>
<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>
</DescribePluginsByApiResponse>
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"
}]
},
}