ListTemplates - 查询模板列表

列举当前用户可见的模板。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

composer:ListTemplates

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

当前页码。起始值:1。默认值:1

1

PageSize

integer

每页大小,最大 100,默认值为 10

10

Name

string

根据指定关键词搜索模板,如果指定了 Tag,则无效

test

Tag

string

根据指定的标签获取模板

财务管理

Lang

string

模板语言:

  • zh:中文

  • en:英文

zh

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

模板总数

10

RequestId

string

本次请求唯一标识符

ADB97A33-50E7-48A5-963D-ACBAE36D0BEC

Templates

array

模板列表

object

模板信息

UpdateTime

string

模板最后更新时间

2020-08-19T03:31:32.415Z

TemplateOverview

string

模板概述,为 JSON 字符串

[]

TemplateConnector

string

模板里用到的连接器列表,多个以英文逗号分隔

oss,rds

CreateTime

string

模板创建时间

2020-08-19T03:31:32.415Z

TemplateSummaryEn

string

英文版的简介

This is a test template

TemplateName

string

模板名称

测试模板

TemplateVersion

integer

模板版本,为从 0 递增的数字

0

TemplateLocale

string

模板语言,目前支持中文 zh 和英文 en 两种

zh

TemplateCreator

string

模板发布者

逻辑编排

TemplateDescription

string

模板的描述

这是一个测试用的模板

TemplateTag

string

模板标签

finance

TemplateSummary

string

模板简要介绍

测试模板的简介

TemplateId

string

模板 ID

tp-uf6tbvhheciyxl

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "ADB97A33-50E7-48A5-963D-ACBAE36D0BEC",
  "Templates": [
    {
      "UpdateTime": "2020-08-19T03:31:32.415Z",
      "TemplateOverview": "[]",
      "TemplateConnector": "oss,rds",
      "CreateTime": "2020-08-19T03:31:32.415Z",
      "TemplateSummaryEn": "This is a test template",
      "TemplateName": "测试模板",
      "TemplateVersion": 0,
      "TemplateLocale": "zh",
      "TemplateCreator": "逻辑编排",
      "TemplateDescription": "这是一个测试用的模板",
      "TemplateTag": "finance",
      "TemplateSummary": "测试模板的简介",
      "TemplateId": "tp-uf6tbvhheciyxl"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情