调用ListTemplate API查询模板列表-云速搭-阿里云

获取模板列表，包括模板名称、架构图地址、架构图序列化文件地址等。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bpstudio:ListTemplate

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

无

请求参数

名称	类型	必填	描述	示例值
NextToken	integer	是	页码	1
MaxResults	integer	是	分页大小	10
OrderType	integer	否	排序字段： 1：按更新时间排序 2：按创建时间排序 3：按系统推荐排序 4：按使用次数排序不输入任何值或输入除了 1，2，3，4 之外的任意整数：按系统推荐排序	1
Keyword	string	否	搜索模板名称关键字	“CADT”
Type	string	是	“public”代表开放模板，“private”代表私有模板。	private
TagList `deprecated`	integer	否	模板的标签	2
ResourceGroupId	string	否	资源组 ID	rg-acfmyjt3c5om3hi
Tag	array<object>	否	标签列表。
	object	否	标签信息
Key	string	否	标签键	tag
Value	string	否	标签值	value

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	总数量	100
Message	string	错误信息	Success
NextToken	integer	页码	1
RequestId	string	请求 ID	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	array<object>	模板列表
	object
ImageURL	string	模板的图片链接	bp-studio-template/sr-U37UD2YQCRJ75X5V.png
TagId `deprecated`	integer	模板的标签的 ID	1
TagName `deprecated`	string	模板标签的名称	TagName
Name	string	模板的名称	cadt-name
TemplateId	string	模板的 ID	CJQ6H0XUEQ20IYJQ
CreateTime	string	创建时间	2021-03-18 16:41:31
ResourceGroupId	string	资源组 ID	rg-acfmyjt3c5om3hi
Tag	array<object>	标签列表
	object	标签信息
Key	string	标签键	tag1
Value	string	标签值	value1
Description	string	模版描述信息
DocumentUrl	string	场景详情
Code	string	状态码	200

示例

正常返回示例

JSON格式

{
  "TotalCount": 100,
  "Message": "Success",
  "NextToken": 1,
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": [
    {
      "ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
      "TagId": 1,
      "TagName": "TagName",
      "Name": "cadt-name",
      "TemplateId": "CJQ6H0XUEQ20IYJQ",
      "CreateTime": "2021-03-18 16:41:31",
      "ResourceGroupId": "rg-acfmyjt3c5om3hi",
      "Tag": [
        {
          "Key": "tag1",
          "Value": "value1"
        }
      ],
      "Description": "",
      "DocumentUrl": ""
    }
  ],
  "Code": "200"
}

错误码

HTTP status code	错误码	错误信息	描述
200	Success	The transaction is successful.
400	ParameterEmpty	You must specify the request parameter.	您必须指定请求参数。
500	ServiceError	A server error occurred. Please try again later.	服务器异常，请稍后再试
404	EntityNotExist.ResourceId	The resource does not exist.	资源不存在
404	EntityNotExist.ResourceGroup	The resource group does not exist.	资源组不存在

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

变更历史

更多信息，参考变更详情。