调用该接口添加设备到分享任务。

使用说明

单次调用本接口添加设备的数量不能超过50。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：AddShareTaskDevice。
ShareTaskId String 是 Md3ZiTL888K9llXDy7890***********

分享任务ID。
IotInstanceId String 否 iot-v64********

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

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

实例的更多信息，请参见实例概述。
IotIdList.N RepeatList 否 y4u2weAIrpp****WHMle1234

待添加的设备列表，需传入设备对应的IotId，该参数可以通过调用QueryDevice获取。

说明 如果传入该参数，则无需传入ProductKey。如果您同时传入IotIdList和ProductKey，则以IotIdList为准。
ProductKey String 否 a2YwD23***

待添加设备所属产品的ProductKey。

您可以在物联网平台控制台或调用接口QueryProductList，查看当前实例下所有产品的信息。

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

返回数据

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

调用失败时，返回的错误码。更多信息，请参见错误码。
Data Struct

返回的添加结果。
FailSum Integer 2

添加失败的设备数量。
FailedResultCsvFile String https://****.csv

添加失败的设备列表文件。
Progress Integer 100

添加进度，可取值0～100。
ProgressId String Md3ZiTL888K9llXDy7890***********

进度ID。
SuccessSum Integer 10

添加成功的设备数量。
ErrorMessage String An internal error occurred. Try again later.

调用失败时，返回的错误信息。
RequestId String 671D0F8F-FDC7-4B12-93FA-336C079C965A

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

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=AddShareTaskDevice
&ShareTaskId=Md3ZiTL888K9llXDy7890***********
&<公共请求参数>

正常返回示例

XML格式

<AddShareTaskDeviceResponse>
  <RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
  <Data>
        <FailedResultCsvFile>https://****.csv</FailedResultCsvFile>
        <Progress>100</Progress>
        <ProgressId>Md3ZiTL888K9llXDy7890***********</ProgressId>
        <FailSum>2</FailSum>
        <SuccessSum>10</SuccessSum>
  </Data>
  <Success>true</Success>
</AddShareTaskDeviceResponse>

JSON格式

{
    "RequestId": "671D0F8F-FDC7-4B12-93FA-336C079C965A",
    "Data": {
        "FailedResultCsvFile": "https://****.csv",
        "Progress": 100,
        "ProgressId": "Md3ZiTL888K9llXDy7890***********",
        "FailSum": 2,
        "SuccessSum": 10
    },
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 iot.speech.InvalidIotInstanceId Invalid instance ID. 无效的实例ID。
400 iot.sharetask.EmptyShareDevice no device to share. 无设备分享。
400 iot.sharetask.ShareDeviceProcessing share device processing. 分享设备处理中。

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