文档首页/ DevStar/ CLI参考/ 命令使用/ 查询模板
更新时间：2022-08-29 GMT+08:00
查看PDF
分享

查询模板

功能

查看系统当前可使用的模板列表。

语法

hcloud DevStar ListTemplates --cli-region="cn-north-1" [--keyword=template_name]

参数说明

表1 请求参数说明

参数名称

是否必选

参数描述

template_name

否

模板名称。程序会根据输入的模板名称模糊匹配当前可以使用的DevStar模板。仅支持字母、数字、下划线和空格。
表2 响应参数说明

参数名称

参数类型

参数描述

count

integer

返回模板的数量。

invalid_count

integer

返回关联了失效资源的模板数量。

templates

Array of TemplateInfo objects

返回模板的列表。
表3 TemplateInfo 参数

名称

参数类型

描述

id

string

模板id。

title

string

模板名。

description

string

模板描述。

productshorts

Array of strings

模板关联的所有云服务(产品名称缩写)。

products

Array of TemplateProductExt objects

模板关联的云产品。

topic

Array of TopicCategory objects

模板标签。

creator_id

string

模板创建者id。

creator

string

模板创建者,有别名返回别名。

nickname

string

模板创建者,有别名返回别名。

score

integer

模板评分(点赞数)。

label

string

模板标签(new、hot等)。

store

integer

代码存储位置。

store_info

string

获取代码模版所需的信息。

status

integer

模板状态:

  • 0:审核中
  • 1:已上架
  • 2:未上架(已下架)
  • 3:未上架(合规检查不通过)
  • 4:未上架(待上架)
  • 5:已删除

view_count

integer

访问量。

usage_count

integer

引用量。

created_at

string

创建时间。

updated_at

string

更新时间。

published_at

string

模板上架时间。

favorite_state

integer

点赞状态:

  • 1:点赞
  • 0:未点赞

tags

Array of TagInfo objects

模板标签。

type

integer

模板类型:

  • 0:doc
  • 1:code
  • 2:pipeline
  • 3:devops

is_static

integer

动、静态代码模板标识:

  • 0:动态模板codetemplate
  • 1:静态模板codesample

maintainers

Array of strings

模板相关联的所有维护人账号名称。

pipeline_template

PipelineTemplateInfo object

流水线模板。

platform_source

integer

平台来源:

  • 0:codelabs
  • 1:devstar

references

Array of Reference objects

相关文档,示例,帖子。

properties

properties object

模板自定义参数列表。

dependencies

Array of dependencies objects

dependency信息。

dependency_type

string

dependency类型。

forum_id

integer

关联论坛板块id。

file_size

integer

模板文件解压缩之后的大小(单位:KB)。

deployment

deployment object

部署信息。

update_id

string

模板关联更新态Id。

is_support_cloudide

boolean

是否支持使用CloudIDE运行源码。

has_notices

boolean

是否有消息。

dependents

Array of Dependent objects

模板部署方式依赖信息。

dependent_services

string

模板关联云服务。

使用示例

执行如下命令，查看模板名称里包含“spring”的模板。

hcloud DevStar ListTemplates --cli-region="cn-north-1" --keyword="springboot"

示例执行成功结果如下:

"count": 3,
  "invalid_count": null,
  "templates": [
    {
      "id": "0ae4cf82f4f3402bb6b7f1fbac6ed4dd",
      "title": "XXX",
      "description": "XXX"
       ...
父主题： 命令使用

相关文档