描述
查询指定插件下绑定的API信息
- 此功能面向开放API的用户
- 用于查询指定插件下已经绑定的API列表信息
- 分页返回
- 绑定关系列表中返回的API在对应的环境中可能已经下线
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribePluginApis |
PluginId | String | 是 | 指定查询要用的插件ID |
PageNumber | Integer | 否 | 指定要查询的页码,默认是1,起始是1 |
PageSize | Integer | 否 | 指定分页查询时每页行数,最大值100,默认值为10 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 本次请求编号 |
TotalCount | Integer | 返回结果的总条数 |
PageNumber | Integer | 返回指定的页码 |
PageSize | Integer | 返回指定的每页条数 |
ApiSummarys | ApiPluginSummary | 由 ApiPluginSummary 组成的数组格式,返回API的定义信息 |
示例
请求示例
http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePluginApis
&PluginId=a96926e82f994915a8da40a119374537
&<公共请求参数>
返回示例
XML
格式
<DescribePluginApisResponse>
<RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId>
<TotalCount>20</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<ApiSummarys>
<ApiPluginSummary>
<ApiId>9a3f1a5279434f2ba74ccd91c295af9f</ApiId>
<ApiName>firstAPI</ApiName>
<RegionId>cn-qingdao</RegionId>
<StageName>RELEASE</StageName>
<GroupId>46c79e78dfab4521a5f737faa805c4e1</GroupId>
<GroupName>firstGroup</GroupName>
<Description>描述</Description>
</ApiPluginSummary>
</ApiSummarys>
</DescribePluginApisResponse>
JSON
格式
{
"RequestId": "2DF14872-77CE-43A4-AB47-C4F128E5AA31",
"TotalCount": "1",
"PageNumber": "1",
"PageSize": "10",
"ApiSummarys": {
"ApiPluginSummary": [{
"ApiId":"9a3f1a5279434f2ba74ccd91c295af9f",
"ApiName":"firstAPI",
"RegionId":"cn-qingdao",
"StageName":"RELEASE",
"GroupId":"46c79e78dfab4521a5f737faa805c4e1",
"GroupName": "firstGroup",
"Description":"描述"
}]
},
}