文档首页/ DevStar/ API参考/ 历史API/ 模板管理/ 查询模板详情（V1）
更新时间：2024-07-04 GMT+08:00
查看PDF
分享

查询模板详情（V1）

功能介绍

查询模板详情，推荐使用V3版本接口。

调试

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

URI

GET /v1/templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

template_id

是

String

模板ID，通过查询模板列表接口可获取相应模板ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Language

否

String

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

枚举值：

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

模板的id。

title

String

模板的名称。

description

String

模板的描述信息。

region_id

String

模板关联的region host id。

repostory_id

String

模板关联的repo id。

code_url

String

模板https下载路径。

ssh_url

String

模板ssh下载路径。

project_uuid

String

项目id。

status

Integer

模板状态。

properties

Array of objects

源数据信息：

  • key：元数据标识
  • defaultValue：用户输入值的默认值
  • isShow：前台界面组件是否展示该元数据
  • isProjectName：是否使用作为项目名称
  • label：前台界面组件展示名称
  • type：前台界面组件类型
  • helpText：前台界面组件帮助文本
  • readOnly：前台界面组件是否可修改
  • required：前台界面组件是否展示必填
  • regType：该元数据进行正则校验类型；简化模板编码使用
  • regPattern：该元数据对应js语法正则表达式
  • regTip：该元数据正则校验提示信息
  • visibleRule：该元数据可见规则
  • isRequired：是否必填
  • isReadOnly：是否只读
  • options：option对象集合
    • displayName：前台界面展示字符串
    • value：该选项值
  • eventOnchange：联动属性集合
    • associatedProperty：被关联Property的key值
    • associatedValue：被关联的value
  • fold：是否折叠
  • show：是否展示该Property

dependencies

Array of objects

dependency信息：

  • id：依赖全局唯一标识
  • name：依赖展示名称
  • description：依赖展示描述
  • recommended：是否推荐使用该依赖
  • versionProperty：该依赖版本被关联Property的key值
  • versionRange：该依赖版本适用范围
  • groupName：分组名称
  • items：分组列表

dependency_type

String

dependency类型：

  • 0：分组
  • 1：不分组
  • null：无分组信息

deployment

Object

部署信息：

  • param：参数对象
    • build：构建类型
    • runtime：函数运行时
    • handler：函数执行入口
    • outputFile：构建产物文件路径
  • target：部署环境

请求示例

无

响应示例

状态码： 200

OK

  • 示例 1 
    {
  "dependencies" : {
    "description" : "Provides fast application restarts, LiveReload, and configurations for enhanced development experience.",
    "groupName" : "",
    "id" : "devtools",
    "items" : [ ],
    "name" : "Spring Boot DevTools",
    "recommended" : false,
    "versionProperty" : "",
    "versionRange" : ""
  },
  "dependency_type" : "0",
  "id" : "b2fe2dce83b04efeaa8b99bb8d44d9c0",
  "properties" : {
    "defaultValue" : "maven",
    "eventOnchange" : [ ],
    "fold" : false,
    "helpText" : "Spring 项目的构建方式",
    "isProjectName" : false,
    "isShow" : true,
    "key" : "buildType",
    "label" : "项目构建方式",
    "options" : {
      "displayName" : "Maven Project",
      "value" : "maven"
    },
    "projectName" : false,
    "readonly" : false,
    "regPattern" : "^(maven|gradle)$",
    "regTip" : "仅允许输入以下值：maven?gradle。 ",
    "required" : false,
    "show" : true,
    "type" : "radio"
  },
  "status" : 4,
  "title" : "test1202"
}

状态码： 400

Bad Request

{
  "error_code" : "HDN.1001",
  "error_msg" : "参数错误"
}

状态码： 401

Unauthorized

{
  "error_code" : "HDN.1001",
  "error_msg" : "权限错误"
}

状态码： 403

Forbidden

{
  "error_code" : "HDN.1001",
  "error_msg" : "权限错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 模板管理

相关文档