Modify a Device Gateway

This API is used by an application to modify a child device gateway in the IoT platform.

You can only modify the gateway of a child device.
The target gateway must be in the same resource space as the current device.
The target gateway ID cannot be the same as the current one.
You cannot modify the gateway of a device with child devices.
Supported child device level: 2.
This API can be used to switch gateway for only one device at a time. For details about how to switch gateway for multiple devices in batches, see Create a Batch Task.

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

POST /v5/iot/{project_id}/devices/{device_id}/change-gateway

**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.
device_id	Yes	String	Parameter description: device ID, which uniquely identifies a device. The value of this parameter is specified during device registration or allocated by the platform. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
gateway_id	Yes	String	Gateway ID, which is the device ID of the parent device.

Status code: 204

No Content

None

Switch the device gateway to d4922d8a-6c8e-4396-852c-164aefa6638f.

POST https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/change-gateway

{
  "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f"
}

None

Parent topic: Device Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.