Updated on 2024-01-26 GMT+08:00

Delete a Product

Function

This API is used by an application to delete a specific product model that has been imported to the IoT platform. This API can delete only the product but not the associated codec. If the product has devices, the product cannot be deleted.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

DELETE /v5/iot/{project_id}/products/{product_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

product_id

Yes

String

Parameter description: product ID, which uniquely identifies a product. It is allocated by the platform after the product is created on the platform. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

app_id

No

String

Parameter description: resource space ID. This parameter is optional. If you have multiple resource spaces, you can use this parameter to specify the resource space that the product to be deleted belongs to. If this parameter is not specified, the product in the default resource space will be deleted. If there is no product in the default resource space, the earliest created product will be deleted. If you have multiple resource spaces and do not want to specify this parameter, contact Huawei technical engineers to combine your resource spaces. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. X-Subject-Token in the response header returned by the API is the desired user token. For details about how to obtain the token, see Token Authentication.

Instance-Id

No

String

Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

None

Example Requests

Deletes a specified product.

DELETE https://{endpoint}/v5/iot/{project_id}/products/{product_id}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

403

FORBIDDEN

404

Not Found

Error Codes

See Error Codes.