有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

用于修改设备的配置信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateUserDevice。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,详见产品支持的 地域列表
DeviceId String 设备ID(从获取设备列表接口ListDevices中获取)
示例值:f8656fa3-e7fa-4cad-a4cc-****
取值可参考:
获取设备列表
Name String 设备名称(仅支持中文、英文、数字、_、-,长度不超过32个字符)
示例值:设备1
TransportProtocol Integer 设备流传输协议,仅国标设备有效,填0则不做更改(1:UDP,2:TCP)
示例值:2
Password String 设备密码(仅国标,网关设备支持)
示例值:111111
Description String 设备描述(仅支持中文、英文、数字、_、-,长度不超过128位)
示例值:这个一个设备
Ip String 设备接入Ip(仅网关接入支持)
示例值:192.168.x.1
Port Integer 设备Port(仅网关接入支持)
示例值:9000
Username String 设备用户名(仅网关接入支持)
示例值:admin
ProtocolType Integer 网关设备接入协议(仅网关接入支持)
示例值:1
取值可参考:
查询网关接入协议
AudioSwitch Integer 音频关开(0:关闭;1:开启)默认开启,关闭时丢弃音频
示例值:1
SubscribeSwitch Integer 订阅开关(0:关闭;1:开启)默认开启,开启状态下会订阅设备通道变化,仅国标NVR设备有效
示例值:1

3. 输出参数

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

4. 示例

示例1 设备不存在

输入示例

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

{
    "DeviceId": "12345678-abcd-efgh-ijkl-1234567890abcd"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "ResourceNotFound",
            "Message": "该资源不存在"
        },
        "RequestId": "26085616-997b-4c4f-b0f5-e487a7956a32"
    }
}

示例2 修改名称成功

输入示例

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

{
    "DeviceId": "12345678-abcd-efgh-ijkl-1234567890abcd",
    "Name": "rtmp10088"
}

输出示例

{
    "Response": {
        "Data": {
            "AccessProtocol": 1,
            "AppId": 1300000000,
            "ClusterId": "12345678-abcd-efgh-ijkl-1234567890abcd",
            "ClusterName": "上海一区",
            "Code": "02Bu9VFOfl",
            "Description": "",
            "GatewayId": "",
            "DeviceId": "12345678-abcd-efgh-ijkl-1234567890abcd",
            "Ip": "",
            "Name": "rtmp10088",
            "OrganizationId": 10092,
            "Password": "",
            "Port": 0,
            "TransportProtocol": 0,
            "Type": 1,
            "Username": "",
            "ProtocolType": 1,
            "Status": 1
        },
        "RequestId": "ade1d1a7-6a0d-44d6-8633-b114e350bce9"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InvalidParameterValue.InvalidDescription 描述填写有误
InvalidParameterValue.InvalidDeviceId 无效的设备ID
InvalidParameterValue.InvalidDevicePasswordLength 设备密码长度应当大于1位并且小于64位
InvalidParameterValue.InvalidGatewayProtocolType 无效的网关接入协议
InvalidParameterValue.InvalidIpv4 无效的Ipv4地址
InvalidParameterValue.InvalidName 名称为空或填写有误
InvalidParameterValue.InvalidUsername 无效的用户名,长度或内容不符合规则
InvalidParameterValue.UnSupportedAccessType 不支持的接入类型
InvalidParameterValue.UnsupportedStreamProtocol 不支持的流协议
ResourceNotFound 资源不存在