创建产品

最近更新时间:2019-04-30 15:09:48

1. 接口描述

本接口(CreateProduct)用于创建一个新的物联网通信产品。

接口请求域名:iotcloud.api.qcloud.com

注意:
同一用户账户下产品名称需保持唯一。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
productName String 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32}
productProperties Json 产品属性

productProperties定义为:

参数名称 类型 描述
productDescription String 产品描述
encryptionType String 加密类型,1表示非对称加密,2表示对称加密。如不填写,默认值是1
region String 产品所属区域,目前只支持广州(gz)
productType Int 产品类型,0为普通产品,1保留暂无意义,2为NB-IoT产品。如不填写,默认值是0

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败,详见 公共错误码 页面
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" 详见本页面的 模块错误码
codeDesc String 模块错误码的英文描述
productName String 产品名称
productID String 产品 ID,腾讯云生成全局唯一 ID

4. 示例

输入


  https://iotcloud.api.qcloud.com/v2/index.php?Action=CreateProduct
  &productName=fruit
  &productProperties={"productDescription":"desc", "encryptionType":"1", region":"gz"}
  &<公共请求参数>

输出

{
    "productID": "ABCDE12345",
    "productName": "fruit",
    "message": "",
    "codeDesc": "Success",
    "code": 0
}

5. 模块错误码

模块错误码 描述
1000 超过产品数量限制
1001 创建的产品名已存在
1100 内部服务器错误,请联系客服
1101 请求参数非法