Help Center/ Intelligent EdgeFabric/ API Reference/ API/ Batch Node Management/ Querying Details About a Batch Node Registration Job
Updated on 2023-11-23 GMT+08:00

Querying Details About a Batch Node Registration Job

Function

This API is used to query details about a batch node registration job. It cannot be used to query the product certificate file.

URI

GET /v2/{project_id}/productmgr/products/{product_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

product_id

Yes

String

Batch node registration job 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.

Response

Status code: 200

Table 3 Parameter in the response body

Parameter

Type

Description

product

Product object

Product job details.

Table 4 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 5 ProductAttributes

Parameter

Type

Description

value

String

Product attributes.

metadata

ProductMetadata object

Basic information about product attributes.

Table 6 ProductMetadata

Parameter

Type

Description

type

String

Product attribute type.

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

Query succeeded.

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

Status Codes

Status Code

Description

200

Query succeeded.

Error Codes

For details, see Error Codes.