文档首页> DevStar> API参考> 历史API> 模板管理> 查询模板列表(V1)
更新时间:2022-08-30 GMT+08:00
分享

查询模板列表(V1)

功能介绍

查询模板列表,推荐使用/v1/templates/query接口。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/templates

表1 Query参数

参数

是否必选

参数类型

描述

keyword

String

搜索关键字,支持按名称和描述搜索,默认null。

offset

Integer

偏移量,表示从此偏移量开始查询,offset大于等于0。

limit

Integer

每页的模板条数,默认10。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

语言类型,缺省值为“zh-cn”。

枚举值:

  • zh-cn:中文

  • en-us:英文

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

返回模板的数量。

templates

Array of TemplateSimpleInfo objects

返回模板的列表。

表4 TemplateSimpleInfo

参数

参数类型

描述

id

String

模板id。

title

String

模板名。

description

String

模板描述。

请求示例

GET https://{endpoint}/v1/templates?keyword=test&limit=10&offset=0

响应示例

状态码: 200

ok

{
  "count" : 1,
  "templates" : [ {
    "id" : "406dd67aaa7b401892ede527b9966d33",
    "title" : "测试模板",
    "description" : "这是一个测试模板"
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "DEVSTAR.1001",
  "error_msg" : "limit : 非法参数"
}

状态码

状态码

描述

200

ok

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品