Creating a Batch Node Registration Job

Updated on 2023-11-23 GMT+08:00

View PDF

Function

This API is used to create a batch node registration job. After the API is successfully called, you can use Base64 to decode the product.package field in the response body into a tar.gz product certificate file, download the edge registration software edge-register and edge-installer from the IEF console, and use the product certificate to manage edge nodes in batches.

URI

POST /v2/{project_id}/productmgr/products

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
ief-instance-id	No	String	Platinum edition instance ID. This parameter is left blank for a professional edition instance.
Content-Type	Yes	String	Message body type (format). The default value is application/json.

**Table 3** Parameter in the request body
Parameter	Mandatory	Type	Description
product	Yes	ProductRequest object	Basic product information.

**Table 4** ProductRequest
Parameter	Mandatory	Type	Description
name	Yes	String	Product name. The value can contain a maximum of 26 characters, including lowercase letters, digits, and hyphens (-), but cannot start or end with a hyphen (-).
description	No	String	Product description.
attributes	No	Map<String,ProductAttributes>	Product attributes.
tags	No	Array of Attributes objects	Product tags.

**Table 5** ProductAttributes
Parameter	Mandatory	Type	Description
value	No	String	Product attribute.
metadata	No	ProductMetadata object	Basic information about product attributes.

**Table 6** ProductMetadata
Parameter	Mandatory	Type	Description
type	No	String	Product attribute type.

**Table 7** Attributes
Parameter	Mandatory	Type	Description
key	No	String	Key of a node property. The key can contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
value	No	String	Value of a node property. The value can contain 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Response

Status code: 201

**Table 8** Parameter in the response body
Parameter	Type	Description
product	ProductResponse object	Product response parameters.

**Table 9** ProductResponse
Parameter	Type	Description
id	String	Product ID.
name	String	Product name.
description	String	Product description.
attributes	Map<String,ProductAttributes>	Product attributes.
project_id	String	Project ID of the account to which the product belongs.
created_at	Integer	Product creation time.
tags	Array of Attributes objects	Product tags.
private_key	String	Product private key.
certificate	String	Product certificate.
ca	String	Product root certificate.
package	String	Base64-encoded character string of the certificate/ca/private_key file. Before use, decode it into a .tar.gz package using Base64.
identifier	String	Credential used when a product is registered using a token.

**Table 10** ProductAttributes
Parameter	Type	Description
value	String	Product attribute.
metadata	ProductMetadata object	Basic information about product attributes.

**Table 11** ProductMetadata
Parameter	Type	Description
type	String	Product attribute type.

**Table 12** Attributes
Parameter	Type	Description
key	String	Key of a node property. The key can contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
value	String	Value of a node property. The value can contain 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Example Request

A batch node registration job is created. The product name is test.

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

Example Response

Status code: 201

Creation succeeded.

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