修改设备网关 - ChangeGateway
功能介绍
应用服务器可调用此接口在物联网平台修改子设备网关。
-
只允许子设备修改网关。
-
目标网关必须和当前设备在同一个资源空间。
-
网关id不能和当前子设备网关id相同。
-
设备如果有下级子设备，则不允许切换网关。
-
支持多级子设备，当前最大支持二级子设备。
-
该接口仅支持创建单个设备切换网关，如需批量切换设备网关，请参见 创建批量任务。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
iotda:devices:changeGateway
Write
app *
-
-
-
-
g:EnterpriseProjectId
URI
POST /v5/iot/{project_id}/devices/{device_id}/change-gateway
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
|
device_id |
是 |
String |
参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
gateway_id |
是 |
String |
网关ID，用于标识设备所属的父设备，即父设备的设备ID。 |
响应参数
状态码：204
No Content
无
请求示例
修改设备网关为d4922d8a-6c8e-4396-852c-164aefa6638f。
POST https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/change-gateway
{
"gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
