文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>主机安全>客户端设置相关接口>获取扫码登录机器列表

获取扫码登录机器列表

最近更新时间：2026-03-18 01:37:02

我的收藏

本页目录：

1. 接口描述

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

获取扫码登录主机列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeLoginTypeHost。
Version 是 String 公共参数，本接口取值：2018-02-28。
Region 否 String 公共参数，此参数为可选参数。
Filters.N 否 Array of Filter
  • Name - string - 是否必填：否 - 主机名
  • InstanceId - string - 是否必填：否 - 实例ID
  • PublicIp - string - 是否必填：否 - 公网IP
  • PrivateIp - string - 是否必填：否 - 私网IP

    • 示例值：[{"ExactMatch": true, "Name": "Name", "Values": [“nameA”]}]
    Limit 否 Integer 限制条数,默认10,最大100
    示例值：10
    Offset 否 Integer 偏移量,默认0
    示例值：0
    Order 否 String 排序方式: [ASC:升序|DESC:降序]
    示例值：DESC
    By 否 String 可选排序列: [Id]
    示例值：Id

    3. 输出参数

    参数名称 类型 描述
    Total Integer 总数
    示例值：10
    List Array of ClientSettingHost 主机列表
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取扫码登录配置机器列表

    获取扫码登录配置机器列表

    输入示例

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

{}

    输出示例

    {
    "Response": {
        "List": [
            {
                "FunctionStatus": 0,
                "Id": 534012791,
                "InstanceId": "lhins-lu9oiylm",
                "MachineExtraInfo": {
                    "HostName": "遵龙-开发测试用",
                    "InstanceID": "lhins-lu9oiylm",
                    "NetworkName": "",
                    "NetworkType": 2,
                    "PrivateIP": "10.2.20.2",
                    "WanIP": "82.156.42.223"
                },
                "Message": "",
                "MessageDesc": "",
                "Name": "遵龙-开发测试用",
                "PrivateIp": "10.2.20.2",
                "PublicIp": "82.156.42.223",
                "Quuid": "15c76928-e4e1-4f0d-8a2a-46c7de784744",
                "RegionInfo": {
                    "Region": "ap-beijing",
                    "RegionCode": "bj",
                    "RegionId": 8,
                    "RegionName": "华北地区 (北京)",
                    "RegionNameEn": "North China (Beijing)"
                },
                "Status": "ONLINE",
                "VpcId": ""
            },
            {
                "FunctionStatus": 0,
                "Id": 526087804,
                "InstanceId": "lhins-fp92s9zi",
                "MachineExtraInfo": {
                    "HostName": "jimmy-lh",
                    "InstanceID": "lhins-fp92s9zi",
                    "NetworkName": "",
                    "NetworkType": 2,
                    "PrivateIP": "10.2.24.2",
                    "WanIP": "81.70.142.244"
                },
                "Message": "",
                "MessageDesc": "",
                "Name": "jimmy-lh",
                "PrivateIp": "10.2.24.2",
                "PublicIp": "81.70.142.244",
                "Quuid": "d93eadd3-885b-4c2c-b223-65149d913cba",
                "RegionInfo": {
                    "Region": "ap-beijing",
                    "RegionCode": "bj",
                    "RegionId": 8,
                    "RegionName": "华北地区 (北京)",
                    "RegionNameEn": "North China (Beijing)"
                },
                "Status": "ONLINE",
                "VpcId": ""
            }
        ],
        "RequestId": "5b0a0e47-db60-40e9-8c58-170e4672e9b9",
        "Total": 2
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    中国站