查询结构化模板简略列表
功能介绍
查询结构化模板简略信息列表。通过该接口可以查询所有自定义结构化模板的关键信息，有字段信息、配置信息和ID等，让您直观的了解到结构化模板信息。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/lts/struct/customtemplate/list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 从IAM服务获取的用户Token，获取方式请参见：获取用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
Content-Type |
是 |
String |
参数解释： 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
results |
Array of BriefStructTemplateModel objects |
参数解释： 查询自定义结构化模板的简略信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_time |
Long |
参数解释： 自定义结构化模板的创建时间。 取值范围： 不涉及。 |
|
id |
String |
参数解释： 自定义结构化模板的ID。 取值范围： 不涉及。 |
|
template_name |
String |
参数解释： 自定义结构化模板名称。 取值范围： 不涉及。 |
|
template_type |
String |
参数解释： 结构化模板的类型。 取值范围：
|
|
project_id |
String |
参数解释： 项目ID。 取值范围： 不涉及。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码，请参见：错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 调用失败响应信息描述。 取值范围： 不涉及。 |
请求示例
获取当前租户的结构化模板简略列表。
GET https://{endpoint}/v3/{project_id}/lts/struct/customtemplate/list
/v3/{project_id}/lts/struct/customtemplate/list
响应示例
状态码：200
请求响应成功。
{
"results" : [ {
"create_time" : 1632897983441,
"id" : "47629e46-287d-478c-8888-xxxxxxxxxxxx",
"template_name" : "jsonTemplate",
"template_type" : "json",
"project_id" : "2a473356cca5487f8373be89xxxxxxxx"
} ]
}
状态码：500
表明服务端能被请求访问到，但是服务内部出错。
{
"error_code" : "LTS.2017",
"error_msg" : "Find struct template failed."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求响应成功。 |
|
500 |
表明服务端能被请求访问到，但是服务内部出错。 |
错误码
请参见错误码。
