更新时间:2025-08-30 GMT+08:00
分享

列出组件模板

功能介绍

列出组件模板

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

component_id

String

组件ID

表2 Query参数

参数

是否必选

参数类型

描述

file_type

String

参数解释:

文件类型

  • JVM JVM配置文件类型

  • LOG4J2 Log4j2日志配置文件类型

  • YML YAML配置文件类型

约束限制

不涉及

取值范围:

  • JVM

  • LOG4J2

  • YML

默认值

不涉及

limit

Long

Limit

offset

Integer

参数解释:

偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sort_key

String

按照属性排序。

sort_dir

String

排序顺序,支持 ASCDESC

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Long

组件模板数量

records

Array of ListComponentTemplate objects

组件模板

表5 ListComponentTemplate

参数

参数类型

描述

version

String

版本

component_id

String

component id.

component_name

String

组件名称

param

String

参数

file_type

String

参数解释:

文件类型

  • JVM JVM配置文件类型

  • LOG4J2 Log4j2日志配置文件类型

  • YML YAML配置文件类型

约束限制

不涉及

取值范围:

  • JVM

  • LOG4J2

  • YML

默认值

不涉及

file_name

String

文件名称

file_path

String

文件路径

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

Response of list running nodes

400

Error response

错误码

请参见错误码

相关文档