帮你快速理解、总结文档立即下载

取消设备分享

最近更新时间:2026-07-18 12:28:52

我的收藏

1. 接口描述

接口请求域名: iotexplorer.tencentcloudapi.com 。

Owner 取消对指定用户的设备分享:

  1. 校验产品 ACL / 子产品禁止 / 设备真实存在;
  2. 只读定位 Owner(必须已存在),并校验 Owner 持有该设备;
  3. 只读定位被取消分享用户(不存在视为已取消,幂等成功);
  4. 删除分享关系记录(不存在视为已取消,幂等成功)。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RevokeShareDeviceFromUser。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,此参数为可选参数。
AppKey String

应用 AppKey,用于解析 IotAppID 并完成签名校验


示例值:afpMLiFlGYThFpvJe
ProductId String

产品 ID


示例值:N5DBOST040
DeviceName String

设备名


示例值:nandy_dev3
OwnerOpenID String

设备所有者 OpenID(必须已存在)


示例值:nandy
ToOpenID String

被取消分享用户 OpenID(不存在视为已取消,幂等成功)


示例值:zz

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RevokeShareDeviceFromUser
<公共请求参数>

{
    "AppKey": "afpMLiFlGYThFpvJe",
    "ProductId": "N5DBOST040",
    "DeviceName": "nandy_dev3",
    "OwnerOpenID": "nandy",
    "ToOpenID": "zz"
}

输出示例

{
    "Response": {
        "RequestId": "c6f8c163-92a4-41bc-9ffa-c81895808e73"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameterValue.InvalidAppKey AppKey 无效
InvalidParameterValue.ShareDeviceToSelf 不能将设备分享给自己
ResourceNotFound.DeviceNotExist 设备不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation.NoPermissionToShareDevice 无权限分享该设备,仅设备所有者可分享
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。
UnsupportedOperation.ProductIsSubProduct 子产品禁止直接绑定家庭,请走网关绑定
UnsupportedOperation.VirtualDeviceCannotBind 虚拟设备禁止绑定 / 解绑