调用该接口查询指定设备的分发结果。

QPS限制

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

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

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

ProductKey String a1ji*****

设备所属产品的ProductKey

DeviceName String testDevcieBwT3Un

设备名称。

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException
  • 调用成功时,返回success
  • 调用失败,返回错误码。详细信息,请参见下文错误码
Data Struct

调用成功后,返回的设备分发结果。

AliyunUid String io****@example.com

设备当前所属阿里云账号。

DeviceName String testDevcieBwT3Un

设备名称。

GmtCreate Long 1676297683000

设备所属分发任务的创建时间(毫秒级时间戳)。

如果设备未分发,则返回当前服务器时间戳。

GmtModified Long 1676297683000

设备所属分发任务的修改时间(毫秒级时间戳)。

如果设备未分发,则返回当前服务器时间戳。

ProductKey String a1ji*****

设备所属产品的ProductKey

SourceIotInstanceId String iot-6ja****

设备所属的源实例ID。

SourceRegion String cn-shanghai

设备所属的源地域。

TargetIotInstanceId String iot-09k****

设备所属的目标实例ID。

TargetRegion String ap-southeast-1

设备所属的目标地域。

ErrorMessage String 系统异常

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

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceProvisioning
&ProductKey=a1ji*****
&DeviceName=testDevcieBwT3Un
&<公共请求参数>

正常返回示例

XML格式

<QueryDeviceProvisioningResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <TargetRegion>ap-southeast-1</TargetRegion>
        <GmtCreate>1676297683000</GmtCreate>
        <TargetIotInstanceId>iot-09k****</TargetIotInstanceId>
        <AliyunUid>io****@example.com</AliyunUid>
        <GmtModified>1676297683000</GmtModified>
        <SourceIotInstanceId>iot-6ja****</SourceIotInstanceId>
        <SourceRegion>cn-shanghai</SourceRegion>
        <ProductKey>a1ji*****</ProductKey>
        <DeviceName>testDevcieBwT3Un</DeviceName>
  </Data>
  <Code>success</Code>
  <Success>true</Success>
</QueryDeviceProvisioningResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TargetRegion": "ap-southeast-1",
        "GmtCreate": 1676297683000,
        "TargetIotInstanceId": "iot-09k****",
        "AliyunUid": "io****@example.com",
        "GmtModified": 1676297683000,
        "SourceIotInstanceId": "iot-6ja****",
        "SourceRegion": "cn-shanghai",
        "ProductKey": "a1ji*****",
        "DeviceName": "testDevcieBwT3Un"
    },
    "Code": "success",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 iot.common.APINotSupportedInInstance This API operation is not supported in this instance. 当前实例不支持该API。
400 iot.common.RamActionPermissionDeny You do not have the RAM permission. 没有资源访问控制(RAM)权限。
400 iot.common.InvalidTenant The Invalid tenant. 不合法的租户或者创建租户失败。
400 iot.common.InvalidFormattedParameter The parameter format is invalid. 参数格式错误。

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