查询模板输入

功能介绍

用于查询指定模板的输入参数。

URI

GET /v2/templates/{template_id}/inputs

请求消息

N/A。

响应消息

• 响应参数

  失败的响应参数如表5所示。

  表2 响应参数

  参数	参数类型	描述
  [自定义key]	Map<String,Object>	key为模板输入参数名称，value为模板输入参数对应的属性信息，详情请参见表3。

  表3 模板输入参数属性信息字段数据结构说明

  参数	参数类型	描述
  required	Boolean	该参数能否置空，true / false。
  default	Integer or String or Float or Boolean	模板内的默认参数。多种类型，根据type字段选择。
  description	String	该参数的描述
  type	String	不同的模板输入参数类型。 string: 字符串类型 integer: 整数类型 boolean: 布尔类型 enum: 枚举类型，如果是枚举类型，则输入中必须有constraints字段内的valid_values字段 float: 浮点数 secret: 密钥类型 password: 密码类型 ip: IP类型
  constraints	Object	表示该参数值的限制规则，详情请参见表4。
  label	String	该参数所属的标签组
  advanced	Boolean	表示该参数为高级配置，必须要有默认值，界面显示默认隐藏。
  immutable	Boolean	表示该参数是否能够被修改

  表4 参数限制结构说明

  参数	参数类型	描述
  in_range	Array of integers	输入值需要大于等于最小值，并小于等于最大值。
  regex	String	输入值需要满足正则表达式
  valid_values	Array of integers/string/float/boolean	输入值需要符合给定值中的任意一个
  equal	Integer or String or Float or Boolean	输入值需要等于该值
  greater_or_equal	Integer or String or Float or Boolean	输入值需要大于等于该值
  greater_than	Integer or String or Float or Boolean	输入值需要大于该值
  less_or_equal	Integer or String or Float or Boolean	输入值需要小于等于该值
  less_than	Integer or String or Float or Boolean	输入值需要小于该值

• 响应示例

  {
      "key1": {
          "default": "192.168.12.22:30303/test_yj/frontend:latest",
          "immutable": false,
          "type": "string"
      },
      "key2": {
          "default": 2,
          "immutable": false,
          "type": "integer"
      },
      "key3": {
          "immutable": true,
          "type": "string"
      },
      "key4": {
          "type": "float",
          "constraints": {
              "greater_or_equal": 0,
              "greater_than": 0,
              "less_or_equal": 2,
              "less_than": 2
          }
      }
  }

状态码

• 正常

  表5 状态码

  状态码	描述
  200	查询模板输入参数成功

• 异常

  表6 状态码

  状态码	描述
  400	请求参数有误
  404	请求资源不存在
  500	服务器遇到了一个未曾预料的状况，导致无法完成对请求的处理。