Querying the Batch Node Registration Job List

Function

This API is used to query the batch node registration job list.

URI

GET /v2/{project_id}/productmgr/products

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of records that can be returned.
offset	No	Integer	Offset. The records after this offset will be queried.
sort	No	String	How the queried items are sorted and displayed. Use colons (:) to separate the reference value and sequence. For example, sort=created_at %3Adesc indicates that items are sorted by creation time in reverse order.

Request

**Table 3** 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.

Response

Status code: 200

**Table 4** Parameter in the response body
Parameter	Type	Description
count	Integer	Number of product jobs.
products	Array of Product objects	Product job details.

**Table 5** Product
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	Time when a product was created.
tags	Array of Attributes objects	Product tags.

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

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

**Table 8** 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

None

Example Response

Status code: 200

Creation succeeded.

{
  "count" : 1,
  "products" : [ {
    "id" : "52b7e862-7b86-4b4d-b805-f580c4a25b0b",
    "name" : "a",
    "description" : "",
    "attributes" : { },
    "project_id" : "ed202955e111444e8ced21a1bd75fc59",
    "created_at" : 1667214079
  } ]
}