# 从产品模板同步 - SyncProductsFromTemplates #### 功能介绍 从产品模板同步。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ROMA/doc?api=SyncProductsFromTemplates)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-roma/roma_06_0018.html)。 #### URI PUT /v2/{project_id}/link/instances/{instance_id}/products/sync-from-templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。兼容20.0场景默认为default。项目ID，获取方式请参见API参考的"附录 \> 获取项目ID"章节。 | | instance_id | 是 | String | 实例ID。兼容20.0场景默认为default。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | product_ids | 是 | Array of integers | 产品id列表 | | template_id | 否 | Integer | 产品模板ID，该字段为数据库中的自增唯一标识符；通过调用查询产品模板接口：GET /v2/{project_id}/link/instances/{instance_id}/product-templates获取响应体中对应的id字段值。值为null时使用各产品当前关联的产品模板，否则使用指定的产品模板。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总数。 | | size | Integer | 本次返回数量。 | | items | Array of [Product] objects | 产品列表。 | 表5Product | 参数 | 参数类型 | 描述 | |:---|:---|:---| | permissions | Array of strings | 权限。 | | id | Integer | 产品ID，该字段为数据库中的自增唯一标识符；通过调用查询产品接口：GET /v2/{project_id}/link/instances/{instance_id}/products获取响应体中对应的id字段值。 | | product_serial | String | 产品唯一序列（系统唯一值，用于MQS的TOPIC中标记产品）。 | | app_id | String | 应用ID。 | | name | String | 产品名称，创建产品时租户内唯一，长度最大64，仅支持中文、英文字母、数字、下划线和中划线。 | | manufacturer_id | String | 产品供应商ID。 | | manufacturer_name | String | 厂商名称。 | | model | String | 产品型号。 | | product_type | Integer | 产品类型，0-普通产品(不支持子设备) 1-网关产品。 | | description | String | 产品描述，长度0-200。 | | protocol_type | Integer | 产品的协议类型，0-mqtt 1-CoAP 2-modbus 4-opcua 5-扩展协议。 | | device_type | String | 产品的设备类型（默认Default）。 | | version | String | 产品版本。 | | created_user | [CreatedUser] object | 创建时的用户。 | | last_updated_user | [LastUpdatedUser] object | 最后更新时的用户。 | | authentication | [Authentication] object | 鉴权 | | created_datetime | Long | 创建时间，timestamp(ms)，使用UTC时区。 | | app_name | String | 应用名称。 | | data_format | Integer | data_format 0-JSON 1-USER_DEFINED | | template_id | Integer | 关联的产品模板ID，该字段为数据库中的自增唯一标识符；通过调用查询产品模板接口：GET /v2/{project_id}/link/instances/{instance_id}/product-templates获取响应体中对应的id字段值。 | | template_name | String | 关联的产品模板名称 | | sync_template_date | Long | 同步产品模板时间，timestamp(ms)，使用UTC时区。 | 表6CreatedUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | 用户ID(保留字段，未使用)。 | | user_name | String | 用户名。 | 表7LastUpdatedUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | 用户ID(保留字段，未使用)。 | | user_name | String | 用户名。 | 表8Authentication | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_name | String | 一型一密/一机一密的用户名。 | | password | String | 一型一密/一机一密的密码，输入要求：至少1个数字，1个大写字母，1个小写字母，1个特殊字符(\~!@#$%\^\&\*()-_=+\|\[{}\];:\<\>/?)，长度8-32个字符。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 | | error_msg | String | 错误描述。 | | request_id | String | 消息ID。 | #### 请求示例 ``` { "template_id" : null, "product_ids" : [ 1, 2 ] } ``` #### 响应示例 **状态码：404** Not Found ``` { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.", "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-roma/ErrorCode.html)。