DescribePluginsByApi - 查询API上绑定的插件

调用DescribePluginsByApi查询指定环境指定API上绑定的一组插件,该API在该环境必须是运行中状态。

接口说明

  • 此功能面向开放API的用户
  • 支持分页

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudapi:DescribePluginsByApiRead
  • ApiGateway
    acs:cloudapi:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

指定要查询的API所属分组ID

3c7a38392e764718ad7673e7b7f535d4
ApiIdstring

指定要查询的API编号

93f4ead4080c4b2da70b7f81f50ae459
StageNamestring

指定要查询的环境。

  • RELEASE: 线上
  • PRE: 预发
  • TEST: 测试
RELEASE

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

46373DC4-19F1-4DC8-8C31-1107289BB5E0
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
Pluginsarray

由PluginAttribute组成的数组格式,返回插件的信息项

object
PluginIdstring

插件ID

9a3f1a5279434f2ba74ccd91c295af9f
ModifiedTimestring

最后修改时间,格林威治时间

2019-01-11T09:29:58Z
PluginDatastring

插件定义语句

{\"unit\":\"MINUTE\",\"apiDefault\":20}
Descriptionstring

插件描述

流控
PluginNamestring

插件名称

firstPlugin
CreatedTimestring

创建时间,格林威治时间

2019-01-11T09:29:58Z
PluginTypestring

插件类型

trafficControl
RegionIdstring

插件所在Region

cn-qingdao

示例

请求示例

http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePluginsByApi
&ApiId=93f4ead4080c4b2da70b7f81f50ae459
&GroupId=3c7a38392e764718ad7673e7b7f535d4
&StageName=RELEASE
&<公共请求参数>

正常返回示例

JSON格式

{  
   "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": "流控",
            "CreatedTime":"2019-01-11T09:29:58Z",
            "ModifiedTime":"2019-01-11T09:29:58Z"
        }]
    }
}

XML格式

<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>流控</Description>
          <CreatedTime>2019-01-11T09:29:58Z</CreatedTime>
          <ModifiedTime>2019-01-11T09:29:58Z</ModifiedTime>
      </PluginAttribute>
   </Plugins>
</DescribePluginsByApiResponse>

错误码

访问错误中心查看更多错误码。

阿里云首页 API 网关 相关技术圈