调用该接口根据设备信息查询分享任务。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：GetShareTaskByDeviceOpen。
IotId String 否 y4u2weAIrpp****WHMle1234

设备ID。

重要 IotId作为设备唯一标识符，和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数，则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。
IotInstanceId String 否 iot-v64********

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。
ProductKey String 否 a2Yw*****

设备所属的产品ProductKey。

重要 如果传入该参数，需同时传入DeviceName。
DeviceName String 否 device1

设备的名称。

重要 如果传入该参数，需同时传入ProductKey。

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回错误码。详细信息，请参见下文错误码。
Data String Md3ZiTL888K9llXDy7890***********

返回的分享任务Code。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetShareTaskByDeviceOpen
&IotId=y4u2weAIrpp****WHMle1234
&<公共请求参数>

正常返回示例

XML格式

<GetShareTaskByDeviceOpenResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>Md3ZiTL888K9llXDy7890***********</Data>
  <Code></Code>
  <Success>true</Success>
</GetShareTaskByDeviceOpenResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": "Md3ZiTL888K9llXDy7890***********",
    "Code": "",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 iot.system.IllegalRequest The request parameter is invalid. 非法的请求参数。
400 iot.system.SystemException An internal error occurred. Try again later. 系统异常。
400 iot.system.InstanceNotFound The instance ID does not exist. 实例ID不存在。

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