首页 API 网关 开发指南 API参考指南 API目录 插件 DescribePluginTemplates - 获取插件模板列表

DescribePluginTemplates - 获取插件模板列表

调试

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

调试

授权信息

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

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

请求参数

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

API网关插件名称

jwtAuth
Languagestring

语言类型。系统权限策略的描述将以此语言返回。

  • en:英文。
  • zh-CN:中文。
  • ja:日文。
zh

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

EF924FE4-2EDD-4CD3-89EC-34E4708574E7
Templatesarray

模板列表

object

模板列表

Titlestring

插件模版标题

template title
DocumentAnchorstring

文档锚点。

anchor
Descriptionstring

描述信息。

balabala
DocumentIdstring

文档ID

41079
Samplestring

样例。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7",
  "Templates": {
    "Template": [
      {
        "Title": "template title",
        "DocumentAnchor": "anchor",
        "Description": "balabala",
        "DocumentId": "41079",
        "Sample": "1"
      }
    ]
  }
}

错误码

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

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