文档首页 > > API参考> API> 查询模板> 查询模板列表

查询模板列表

分享
更新时间:2020/06/28 GMT+08:00

功能介绍

查询模板列表。

调试

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

URI

GET /v1/templates

表1 Query参数

参数

是否必选

参数类型

描述

keyword

String

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

最小长度:0

最大长度:256

offset

Integer

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

最小值:0

最大值:100000

缺省值:0

limit

Integer

每页的模板条数,默认10

最小值:1

最大值:100

缺省值:10

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

语言类型 中文:zh-cn 英文:en-us。

枚举值:

  • zh-cn
  • en-us

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

count

Integer

返回模板的数量。

最小值:0

最大值:1000000

templates

Array of TemplateSimpleInfo objects

返回模板的列表。

表4 TemplateSimpleInfo

参数

参数类型

描述

id

String

模板id。

最小长度:32

最大长度:32

title

String

模板名。

最小长度:1

最大长度:128

description

String

模板描述。

最小长度:1

最大长度:255

请求示例

GET https://{endpoint}/v1/templates?kwyword=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

错误码

请参见 API错误中心

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问