查询插件配置模板列表 - ListComponentTemplates
功能介绍
查询在配置流程时的插件配置模板列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/components/template
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间ID 取值范围: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search_value |
否 |
String |
插件配置模板名称 |
|
offset |
否 |
Integer |
参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
limit |
否 |
Integer |
参数解释: 数据量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 响应的返回码 约束限制: 不涉及 |
|
total |
Integer |
参数解释: 数据总条数 约束限制: 不涉及 |
|
offset |
Integer |
参数解释: 当前页大小 约束限制: 不涉及 |
|
limit |
Integer |
参数解释: 当前页码 约束限制: 不涉及 |
|
message |
String |
参数解释: 响应的错误信息 约束限制: 不涉及 |
|
data |
Array of TemplateInfo objects |
插件配置模板列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
模板id |
|
component_id |
String |
插件id |
|
template_name |
String |
插件配置模板名称 |
|
task_config |
String |
插件action的配置内容 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
更新时间 |
|
project_id |
String |
项目id |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Response of template list |
|
400 |
Error response |
错误码
请参见错误码。