文档首页/ 智能边缘平台 IEF/ API参考/ API/ 批量节点管理/ 创建批量节点注册作业 - CreateProduct
更新时间:2025-12-03 GMT+08:00
分享

创建批量节点注册作业 - CreateProduct

功能介绍

创建批量节点注册作业。接口调用成功后,您可以将响应消息体中product.package字段使用base64解码成tar.gz产品证书文件,并在控制台下载边缘注册软件edge-register和edge-installer,使用该产品证书批量纳管边缘节点。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

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

URI

POST /v2/{project_id}/productmgr/products

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

ief-instance-id

String

企业版实例ID,专业版实例为空值。

Content-Type

String

消息体的类型(格式),默认取值为“application/json”。

表3 请求Body参数

参数

是否必选

参数类型

描述

product

ProductRequest object

产品基本信息

表4 ProductRequest

参数

是否必选

参数类型

描述

name

String

产品名称,允许输入小写字母,数字,中划线,不能以中划线开头或结尾,最大长度为26位

description

String

产品描述

attributes

Map<String,ProductAttributes>

产品属性值

tags

Array of Attributes objects

产品标签

表5 ProductAttributes

参数

是否必选

参数类型

描述

value

String

产品属性值

metadata

ProductMetadata object

产品属性值基本信息

表6 ProductMetadata

参数

是否必选

参数类型

描述

type

String

产品属性值类型,支持

  • int:整型

  • string:字符串类型

  • float:浮点型

  • boolean:布尔型

表7 Attributes

参数

是否必选

参数类型

描述

key

String

节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线

响应参数

状态码:201

表8 响应Body参数

参数

参数类型

描述

product

ProductResponse object

产品响应参数

表9 ProductResponse

参数

参数类型

描述

id

String

产品id

name

String

产品名称

description

String

产品描述

attributes

Map<String,ProductAttributes>

产品属性值

project_id

String

产品所属账号的项目ID

created_at

Integer

产品创建时间戳

tags

Array of Attributes objects

产品标签

private_key

String

产品私钥

certificate

String

产品证书

ca

String

产品根证书

package

String

将产品证书文件certificate/ca/private_key打成.tar.gz包后用base64编码的字符串。

使用时请使用base64解码成.tar.gz包。

identifier

String

产品使用token注册时的凭证

表10 ProductAttributes

参数

参数类型

描述

value

String

产品属性值

metadata

ProductMetadata object

产品属性值基本信息

表11 ProductMetadata

参数

参数类型

描述

type

String

产品属性值类型,支持

  • int:整型

  • string:字符串类型

  • float:浮点型

  • boolean:布尔型

表12 Attributes

参数

参数类型

描述

key

String

节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线

请求示例

创建批量节点注册作业,产品名为“test”。当用户未配置日志相关字段时,将默认打开日志上传到云端功能。

{
  "product" : {
    "name" : "test",
    "description" : "",
    "attributes" : { },
    "tags" : [ ]
  }
}

响应示例

状态码:201

创建成功

{
  "product" : {
    "id" : "52b7e862-7b86-4b4d-b805-f580c4a25b0b",
    "name" : "a",
    "description" : "",
    "attributes" : { },
    "project_id" : "ed202955e111444e8ced21a1bd75fc59",
    "created_at" : 1667214079,
    "private_key" : "",
    "certificate" : "",
    "ca" : "",
    "package" : ""
  }
}

状态码

状态码

描述

201

创建成功

错误码

请参见错误码

相关文档