文档

BatchGrayMigrationDevice

更新时间:

调用该接口持续灰度迁移新增设备。

使用说明

实例迁移时,如果有新增设备未灰度迁移,可以调用本接口持续灰度迁移增量设备。

调用本接口前,已在物联网平台控制台创建灰度迁移任务,并灰度验证完成,任务已处于灰度完成状态。具体操作,请参见实例迁移

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。

说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String BatchGrayMigrationDevice

系统规定参数。取值:BatchGrayMigrationDevice。

DeviceNames.N RepeatList light

待灰度迁移的设备名称列表。

单次调用本接口,最多传入10个设备名称。超出10个的设备名称会被直接丢弃。

ProductKey String a1BwAGV****

设备所属产品的ProductKey

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称

类型

示例值

描述

Code String iot.system.SystemException

调用失败时,返回错误码。详细信息,请参见下文错误码

Data Struct

返回的迁移结果。

Details Array of item

返回的设备迁移状态信息。

item
Code Integer 500

迁移失败返回的错误码。

DeviceName String light

设备名称。

Message String 系统错误

迁移失败,返回的出错信息。

Status String SUCCEEDED

设备迁移状态。

  • DEVICE_SUCCEEDED:成功。
  • DEVICE_FAILED:失败。
ErrorMessage String 系统异常

调用失败时,返回的出错信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchGrayMigrationDevice
&DeviceNames.1=light
&ProductKey=a1BwAGV****
&<公共请求参数>

正常返回示例

XML格式

<BatchGrayMigrationDeviceResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Details>
              <item>
                    <Status>DEVICE_SUCCEEDED</Status>
                    <DeviceName>light</DeviceName>
              </item>
        </Details>
  </Data>
  <Success>true</Success>
</BatchGrayMigrationDeviceResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Details": {
            "item": {
                "Status": "DEVICE_SUCCEEDED",
                "DeviceName": "light"
            }
        }
    },
    "Success": true
}

  • 本页导读 (1)