ListTemplate - 查询模板列表

更新时间:2025-03-12 02:42:16

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

调试

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

授权信息

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

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

请求参数

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

页码

1
MaxResultsinteger

分页大小

10
OrderTypelong

排序字段:

  • 1:按更新时间排序
  • 2:按创建时间排序
  • 3:按系统推荐排序
  • 4:按使用次数排序
  • 不输入任何值或输入除了 1,2,3,4 之外的任意整数:按系统推荐排序
1
Keywordstring

搜索模板名称关键字

“CADT”
Typestring

“public”代表开放模板,“private”代表私有模板。

private
TagListinteger

模板的标签

2
ResourceGroupIdstring

资源组 ID

rg-acfmyjt3c5om3hi

返回参数

名称类型描述示例值
名称类型描述示例值
object
TotalCountinteger

总数量

100
Messagestring

错误信息

Success
NextTokeninteger

页码

1
RequestIdstring

请求 ID

A07FFDF2-78FA-1B48-9E38-88E833A93187
Dataarray<object>

模板列表

Itemobject
ImageURLstring

模板的图片链接

bp-studio-template/sr-U37UD2YQCRJ75X5V.png
TagIdinteger

模板的标签的 ID

1
TagNamestring

模板标签的名称

官方模板
Namestring

模板的名称

cadt-name
TemplateIdstring

模板的 ID

CJQ6H0XUEQ20IYJQ
CreateTimestring

创建时间

2021-03-18 16:41:31
ResourceGroupIdstring

资源组 ID

rg-acfmyjt3c5om3hi
Codeinteger

状态码

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": "官方模板",
      "Name": "cadt-name",
      "TemplateId": "CJQ6H0XUEQ20IYJQ",
      "CreateTime": "2021-03-18 16:41:31",
      "ResourceGroupId": "rg-acfmyjt3c5om3hi"
    }
  ],
  "Code": 200
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
200SuccessThe transaction is successful.交易成功
400ParameterEmptyYou must specify the request parameter.您必须指定请求参数。
404EntityNotExist.ResourceIdThe resource does not exist.资源不存在
404EntityNotExist.ResourceGroupThe resource group does not exist.资源组不存在
500ServiceErrorA server error occurred. Please try again later.服务器异常,请稍后再试

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2023-05-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
  • 本页导读 (0)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等