新增设备

1. 接口描述

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

用于新增单个设备。添加设备之后，可根据返回结果到设备上进行配置，配置后等待设备注册/推流。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 rtmp成功

输入示例

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

{
    "Name": "rtmp10087",
    "AccessProtocol": 1,
    "Type": 1,
    "OrganizationId": "192",
    "ClusterId": "4169d92e-****-****-****-************"
}

输出示例

{
    "Response": {
        "Data": {
            "AccessProtocol": 1,
            "AppId": 1300000000,
            "ClusterId": "4169d92e-****-4c16-****-d313****0790",
            "ClusterName": "上海一区",
            "Code": "0******Ofl",
            "Description": "",
            "GatewayId": "",
            "DeviceId": "********-53e4-****-a16e-*************",
            "Ip": "",
            "Name": "rtmp10087",
            "OrganizationId": 1000192,
            "Password": "",
            "Port": 0,
            "TransportProtocol": 0,
            "Type": 1,
            "Username": "",
            "ProtocolType": 1,
            "Status": 1
        },
        "RequestId": "6836e76d-8e7d-48d3-98c2-bc0df3bf23c2"
    }
}

示例2 success

成功

输入示例

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

{
    "Name": "testrtmp",
    "AccessProtocol": 1,
    "Type": 1,
    "OrganizationId": "189",
    "ClusterId": "4169d92e-****-****-****-************",
    "AppName": "testapp",
    "StreamName": "teststream"
}

输出示例

{
    "Response": {
        "Data": {
            "AccessProtocol": 1,
            "AppId": 1300056079,
            "ClusterId": "4169d92e-****-****-****-************",
            "ClusterName": "上海一区",
            "Code": "0HQq******",
            "Description": "",
            "DeviceId": "f1f9baae-****-****-****-************",
            "GatewayId": "",
            "Ip": "",
            "Name": "testrtmp",
            "OrganizationId": 189,
            "Password": "37********10",
            "Port": 0,
            "ProtocolType": 0,
            "Status": 0,
            "TransportProtocol": 0,
            "Type": 1,
            "Username": ""
        },
        "RequestId": "56d8591d-85cb-498d-a5b6-52133305e69c"
    }
}

示例3 无效的设备类型

输入示例

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

{
    "Name": "rtmp10086",
    "AccessProtocol": 1,
    "Type": 2,
    "OrganizationId": "10092",
    "ClusterId": "********-60ad-*****-ac7e-d******dd0790"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.InvalidDeviceType",
            "Message": "无效的设备类型"
        },
        "RequestId": "d4a82b07-08a2-47ba-8f22-04ce429a0dcd"
    }
}

示例4 设备类型错误

输入示例

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

{
    "Name": "rtmp10086",
    "AccessProtocol": 1,
    "Type": 2,
    "OrganizationId": "10092",
    "ClusterId": "12345678-****-****-****-************"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue",
            "Message": "无效的参数"
        },
        "RequestId": "1647459e-2715-4adb-a074-0c3d4df7d6a4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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