文档首页 > > API参考> API> 查询模板> 获取模板详情

获取模板详情

分享
更新时间:2020/07/31 GMT+08:00

功能介绍

获取指定模板详情,包括模板id、名称、描述、作者、标签、上架时间等信息。

调试

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

URI

GET /v3/templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

template_id

String

模板ID,通过查询模板列表可获取相应的模板ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

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

枚举值:

  • zh-cn:中文
  • en-us:英文

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

id

String

模板id。

title

String

模板名称。

description

String

模板描述。

creator_id

String

模板创建者id。

creator

String

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

nickname

String

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

score

Integer

模板评分(点赞数)。

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

点赞状态:

  • 0:未点赞。
  • 1:点赞。

maintainers

Array of strings

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

platform_source

Integer

平台来源:

  • 0:CodeLabs。
  • 1:DevStar。

properties

Object

模板自定义参数列表。

dependencies

Array of objects

dependency信息。

dependency_type

String

dependency类型:

  • '0':非分组的依赖类型。
  • '1':分组依赖类型。

请求示例

GET https://{endpoint}/v3/templates/0633650ed8a7e69212eed4c348eb6b8d

响应示例

状态码为 200 时:

OK(当dependency_type为1时)

{
  "id" : "12345678901234567890123456789012",
  "title" : "DevCloud Demo1",
  "description" : "软件开发云演示项目",
  "creator" : "someone",
  "nickname" : "小黑",
  "score" : 9999,
  "status" : 1,
  "view_count" : 1432,
  "usage_count" : 256,
  "created_at" : "2019-09-20T18:20:30Z",
  "updated_at" : "2019-11-20T13:22:30Z",
  "published_at" : "2019-11-20T13:26:39Z",
  "favorite_state" : 0,
  "maintainers" : [ "devstar_s12345" ],
  "properties" : [ {
    "key" : "projectName",
    "defaultValue" : "angular",
    "label" : "Project Name",
    "type" : "text",
    "helpText" : "Name of the Project.",
    "readOnly" : false,
    "required" : false,
    "regType" : "reg",
    "regPattern" : "^[a-z0-9-_@/]{1,64}$",
    "regTip" : "请输入1-64位数字、小写字母、中划线、下划线、斜线、@",
    "options" : [ ],
    "eventOnchange" : [ ],
    "show" : true,
    "projectName" : false,
    "isShow" : true,
    "isProjectName" : false
  } ],
  "dependencies" : [ {
    "description" : "",
    "groupName" : "Developer Tools",
    "id" : "",
    "items" : [ {
      "description" : "Provides fast application restarts, LiveReload, and configurations for enhanced development experience.",
      "id" : "devtools",
      "name" : "Spring Boot DevTools",
      "recommended" : false,
      "versionProperty" : "",
      "versionRange" : ""
    } ],
    "name" : "",
    "recommended" : false,
    "versionProperty" : "",
    "versionRange" : ""
  } ],
  "dependency_type" : "1"
}

OK(当dependency_type为0时)
{
  "id" : "12345678901234567890123456789012",
  "title" : "DevCloud Demo1",
  "description" : "软件开发云演示项目",
  "creator" : "someone",
  "nickname" : "小黑",
  "score" : 9999,
  "status" : 1,
  "view_count" : 1432,
  "usage_count" : 256,
  "created_at" : "2019-09-20T18:20:30Z",
  "updated_at" : "2019-11-20T13:22:30Z",
  "published_at" : "2019-11-20T13:26:39Z",
  "favorite_state" : 0,
  "maintainers" : [ "devstar_s12345" ],
  "properties" : [ {
    "key" : "projectName",
    "defaultValue" : "angular",
    "label" : "Project Name",
    "type" : "text",
    "helpText" : "Name of the Project.",
    "readOnly" : false,
    "required" : false,
    "regType" : "reg",
    "regPattern" : "^[a-z0-9-_@/]{1,64}$",
    "regTip" : "请输入1-64位数字、小写字母、中划线、下划线、斜线、@",
    "options" : [ ],
    "eventOnchange" : [ ],
    "show" : true,
    "projectName" : false,
    "isShow" : true,
    "isProjectName" : false
  } ],
  "dependencies" : [{
      "description" : "Provides fast application restarts, LiveReload, and configurations for enhanced development experience.",
      "id" : "devtools",
      "name" : "Spring Boot DevTools",
      "recommended" : false,
      "versionProperty" : "",
      "versionRange" : ""
    }],
  "dependency_type" : "0"
}

状态码为 400 时:

Bad Request

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

状态码为 404 时:

Not Found

{
  "error_code" : "DEVSTAR.1037",
  "error_msg" : "该模板不存在"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

错误码

请参见 API错误中心

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问