AddShareTaskDevice_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

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

QPS 限制

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
ShareTaskIdstring

分享任务 ID。

示例值:Md3ZiTL888K9llXDy7890***********
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot-v64********
ProductKeystring

待添加设备所属产品的 ProductKey展开详情

示例值:a2YwD23***参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
IotIdListarray<string>

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

示例值:y4u2weAIrpp****WHMle1234 子级条数 <= 10000

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:An internal error occurred. Try again later.
RequestIdstring

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

示例值:671D0F8F-FDC7-4B12-93FA-336C079C965A
Successboolean

是否调用成功。展开详情

示例值:true
Dataobject

返回的添加结果。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.speech.InvalidIotInstanceId
Invalid instance ID.诊断
400
iot.sharetask.EmptyShareDevice
no device to share.诊断
400
iot.sharetask.ShareDeviceProcessing
share device processing.诊断
400
Iot.sharetask.ImportDevicePartFail
Failed to import some of the devices.诊断

变更历史

暂无变更历史