V2.1 Update Product


更新产品。

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

操作权限


使用此 API 前,确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息,参见 管理服务账号


需授权的服务

所需操作权限

产品

Update

前提条件


  • 需更新的产品已存在。

  • 已阅读产品相关的 使用限制

请求格式

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

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织 ID。如何获取 orgId 信息>>

productKey

Query

必需

String

产品的 Product Key。如何获取 productKey 信息>>

请求参数(Body)

名称

必需/可选

数据类型

描述

productDesc

可选

String

  • true:返回产品描述信息。

  • false (默认):不返回产品描述信息。

biDirectionalAuth

可选

Boolean

双向认证是通过 CA 证书机制对数据进行加密和解密的过程,确保在设备和云之间进行更安全的通信。更多信息,参见 基于证书的双向认证
  • true:支持双向认证。

  • false (默认):不支持双向认证。

dynamicActivateEnabled

可选

Boolean

  • true:支持动态激活。

  • false (默认):不支持动态激活。

productName

可选

StringI18n

产品名称,如果没填 productName 将不更新。结构参见 国际化名称结构体

productTags

可选

Map

产品标签。如何使用标签 >>

defaultValidDay

可选

Integer

此参数在该产品下的设备申请证书时使用。当设备申请证书但未指定有效期时,此参数将作为证书有效期。范围为 1 到 3650,默认值为 730。

maxValidDay

可选

Integer

当该产品下的设备申请证书时,作为设备的最大证书有效期。若超出有效期则报错,申请证书失败。范围为 1 到 3650,默认值为 1095。

响应参数

名称

数据类型

描述

data

String

更新的产品的 key。

示例

请求示例

url: https://{apigw-address}/connect-service/v2.1/products?action=update&orgId=yourOrgId&productKey=yourProductKey
method: POST
requestBody:
{
    "productDesc":"test_sdk_update",
    "biDirectionalAuth":true,
    "dynamicActivateEnabled":true,
    "productName": {
        "defaultValue":"AlterTest0615_Product",
        "i18nValue":{}
    }
}

返回示例

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

SDK 示例


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