调用该接口,迁移设备所在的实例。

调用该接口迁移设备所在的实例前,请您联系技术支持人员进行迁移方案评估,防止迁移后功能无法使用。

前提条件
  • 被迁移的设备已开通视频服务功能。
    • 公共实例的设备:登录物联网平台控制台,单击公共实例。在左侧菜单栏,选择视频服务 > 接入服务。在接入服务页面,单击产品管理页签。确认待迁移设备所在产品,对应已开通/未开通状态列为已开通
    • 企业版视频型实例的设备:默认已开通视频服务。
  • 设备分发任务已经完成。详细信息,请参考CreateDeviceDistributeJob设备分发
  • 确保摄像头设备已配置图片生命周期。若摄像头设备未配置图片生命周期,调用该接口后,会自动设置图片生命周期为180天。详细信息,请参考SetDevicePictureLifeCycle
背景信息
  • 若迁移的源实例与目标实例类型不同,迁移前请了解实例的计费方式。计费方式详细内容,请参考计费概述
  • 迁移过程中,设备会离线,设备数量越多迁移时间越长,在此期间设备产生的数据无法保留。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String TransferDeviceInstance

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

DeviceNameList.N RepeatList RepeatList

待迁移的设备名称列表。最多包含100个设备名称。

ProductKey String a1BwAGV****

设备所属产品的ProductKey,创建产品时,物联网平台为该产品生成的唯一标识。

TargetInstanceId String iot-060***

设备迁移的目标实例ID。目标实例仅支持企业版视频型实例。

您可登录物联网平台控制台,在实例概览页面,单击实例名称,在实例详情页面的实例基本信息中查看实例ID

SourceInstanceId String iotx-oxssharez200

设备所属的源实例ID:

  • 公共实例ID:iotx-oxssharez200。
    说明 目前仅支持华东2(上海)地域,其实例ID为iotx-oxssharez200。
  • 企业版实例ID:登录物联网平台控制台,在实例概览页面,单击实例名称,在实例详情页面的实例基本信息中查看实例ID

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

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

查询结果。

FailedList Array of FailedList

迁移失败的设备列表。

DeviceName String e5jdfalekj****

设备名称。

Message String 设备已经转移或不属于来源实例

迁移失败的描述信息。

SuccessList Array of SuccessList

迁移成功的设备列表。

DeviceName String e598798j****

设备名称。

Message String success

迁移成功的描述信息。

ErrorMessage String 来源实例和目标实例不能相同

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

RequestId String 27AF2E38-12ED-4F67-BD20-36E812CD7A42

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=TransferDeviceInstance
&DeviceNameList.1=RepeatList
&ProductKey=a1BwAGV****
&TargetInstanceId=iot-060***
&<公共请求参数>

正常返回示例

XML格式

<TransferDeviceInstanceResponse>
  <RequestId>F1F1CD2E-0918-4804-9D44-8C3EE26DD3B5</RequestId>
  <Data>
        <SuccessList>
              <Message>success</Message>
              <DeviceName>QYA1</DeviceName>
        </SuccessList>
        <SuccessList>
              <Message>success</Message>
              <DeviceName>QYA2</DeviceName>
        </SuccessList>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</TransferDeviceInstanceResponse>

JSON格式

{
  "RequestId": "F1F1CD2E-0918-4804-9D44-8C3EE26DD3B5",
  "Data": {
    "FailedList": [],
    "SuccessList": [
      {
        "Message": "success",
        "DeviceName": "QYA1"
      },
      {
        "Message": "success",
        "DeviceName": "QYA2"
      }
    ]
  },
  "Code": "200",
  "Success": true
}

错误码

访问错误中心查看更多错误码。