文档首页/应用与数据集成平台 ROMA Connect/API参考/设备集成API/产品模板/查询产品模板 - ListProductTemplates
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询产品模板 - ListProductTemplates

功能介绍

查询产品模板。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v2/{project_id}/link/instances/{instance_id}/product-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。兼容20.0场景默认为default。项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID。兼容20.0场景默认为default。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示条目数量，最大数量999，超过999后只返回999。

id

否

Integer

产品模板ID，该字段为数据库中的自增唯一标识符；通过调用查询产品模板接口：GET /v2/{project_id}/link/instances/{instance_id}/product-templates获取响应体中对应的id字段值。

name

否

String

产品模板名称。

status

否

Integer

产品模板状态 0-启用 1-停用。

created_user_name

否

String

创建用户名。

created_date_start

否

Long

创建时间起始，格式timestamp(ms)，使用UTC时区。

created_date_end

否

Long

创建时间截止，格式timestamp(ms)，使用UTC时区。

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数。

size

Integer

本次返回数量。

items

Array of ProductTemplate objects

产品模板信息。

表5 ProductTemplate

参数

参数类型

描述

id

Integer

产品模板ID，该字段为数据库中的自增唯一标识符；通过调用查询产品模板接口：GET /v2/{project_id}/link/instances/{instance_id}/product-templates获取响应体中对应的id字段值。

name

String

产品模板名称。

description

String

产品模板描述。

status

Integer

产品模板状态，0-启用，1-停用。

created_user

CreatedUser object

创建时的用户。

last_updated_user

LastUpdatedUser object

最后更新时的用户。

created_datetime

Long

创建时间，timestamp(ms)，使用UTC时区。

last_updated_datetime

Long

最后修改时间，timestamp(ms)，使用UTC时区。

表6 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段，未使用)。

user_name

String

用户名。

表7 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段，未使用)。

user_name

String

用户名。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。

error_msg

String

错误描述。

request_id

String

消息ID。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。

error_msg

String

错误描述。

request_id

String

消息ID。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。

error_msg

String

错误描述。

request_id

String

消息ID。

请求示例

GET /{project_id}/link/instances/{instance_id}/product-templates

响应示例

状态码：200

OK

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "id" : 2235,
    "name" : "template",
    "description" : "description",
    "status" : 0,
    "created_user" : {
      "user_id" : "",
      "user_name" : "user"
    },
    "last_updated_user" : {
      "user_id" : "",
      "user_name" : "user"
    },
    "created_datetime" : 1607303564596,
    "last_updated_datetime" : 1607571061057
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-producttemplate.pageQuery]. Parameter is [status]. Processor is [query].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码：404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

状态码：500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：产品模板