V2.1 Create Product¶

创建产品。

该 API 支持在 EnOS 2.1.0 及以上环境中使用。

操作权限¶

确保已获取调用该 API 的权限。更多信息，参见获取 API 调用权限。

前提条件¶

确保已阅读产品的使用限制。

请求格式¶

POST https://{apigw-address}/connect-service/v2.1/products?action=create

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	产品所属的 OU ID。如何获取 orgId 信息>>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
modelId	必需	String	产品所属模型 ID。如何获取 modelId 信息>>
productName	必需	StringI18n	产品名称。结构参见国际化名称结构体。
productType	必需	String	产品类型。`Device` 表示设备， `Gateway` 表示网关。
biDirectionalAuth	必需	Boolean	是否支持双向认证。`True` 表示支持，`False` 表示不支持。双向认证是通过 CA 证书机制对数据进行加密和解密的过程，确保在设备和云之间进行更安全的通信。更多信息，参见基于证书的双向认证。
dataFormat （弃用）	必需	String	数据格式。仅支持 `Json`，表示只支持 EnOS 设备协议格式。
productDesc	可选	String	`true`：返回产品描述信息。 `false` （默认）：不返回产品描述信息。
dynamicActivateEnabled	可选	Boolean	`true`：支持动态激活。 `false` （默认）：不支持动态激活。
productTags	可选	Map	产品标签。如何使用标签 >>
defaultValidDay	可选	Integer	仅当 `biDirectionalAuth` 为 `true` 时适用。此参数在该产品下的设备/网关申请证书时使用。当设备/网关申请证书但未指定有效期时，此参数将作为证书有效期。范围为 1 到 3650，默认值为 730。
maxValidDay	可选	Integer	仅当 `biDirectionalAuth` 为 `true` 时适用。当该产品下的设备/网关申请证书时，作为设备/网关的最大证书有效期。若超出有效期则报错，申请证书失败。范围为 1 到 3650，默认值为 1095。

响应参数¶

名称	数据类型	描述
data	String	创建的产品的 product key。

错误码¶

代码	错误信息	描述
99500	Query model failed	`modelId` 不存在。

示例¶

请求示例¶

url: https://{apigw-address}/connect-service/v2.1/products?action=create&orgId=yourOrgId
method: POST
requestBody:
{
    "modelId":"yourModelId",
    "productName":{
        "defaultValue":"Product Name",
        "i18nValue":{
      "zh_CN": "产品名称",
      "en_US": "Product Name"
        }
    },
    "productType":"Device",
    "biDirectionalAuth":false,
    "dataFormat":"Json",
    "productDesc":"Product description",
    "productTags":{
        "tag1":"tag value"
    }
}

返回示例¶

{
    "code":0,
    "msg":"OK",
    "requestId":"522d0269-445d-4f13-be04-1424e0e2893e",
    "data":"yourProductKey"
}

SDK 示例¶

你可以在 Github 上获取接入服务的 SDK 示例：

Java
Python