查询设备详情

1. 接口描述

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

用于查询设备的详细信息。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 rtmp

ok

输入示例

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

{
    "DeviceId": "da238a8c-****-4a5b-****-ddba25945b48"
}

输出示例

{
    "Response": {
        "Data": {
            "AccessProtocol": 1,
            "ClusterId": "12345678-abcd-efgh-ijkl-1234567890abcd",
            "ClusterName": "",
            "Code": "2*****vkVe",
            "Description": "",
            "GatewayId": "",
            "GatewayName": "",
            "DeviceId": "12345678-abcd-efgh-ijkl-1234567890abcd",
            "Ip": "",
            "Manufacturer": "",
            "Name": "iss-qta-dont-delete",
            "OrganizationId": "22",
            "Password": "",
            "Port": 0,
            "ProtocolType": 0,
            "ProtocolTypeName": "",
            "PushStreamUrl": "rtmp://81.**.54.**/live/2*****4vkVe",
            "Region": "",
            "SipDomain": "",
            "SipId": "",
            "SipIp": "",
            "SipPort": 0,
            "Status": 0,
            "TransportProtocol": 0,
            "Type": 1,
            "Username": ""
        },
        "RequestId": "c3e6cbee-7a30-49b0-8415-af3cc46fe257"
    }
}

示例2 无效的设备Id

无效的设备Id

输入示例

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

{
    "DeviceId": "aaa"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.InvalidDeviceId",
            "Message": "无效的设备Id"
        },
        "RequestId": "97694623-ae7d-435c-aff7-f5a051fe9474"
    }
}

示例3 无效的设备Id错误

输入示例

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

{
    "DeviceId": "66666666-53e4-4a79-a16e-8504f8366a531"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.InvalidDeviceId",
            "Message": "无效的设备Id"
        },
        "RequestId": "c3c7c853-e5cf-4829-87f8-375b0623d750"
    }
}

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: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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