获取账号列表

最近更新时间:2024-10-30 19:38:51

我的收藏

1. 接口描述

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

获取账号列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAssetUserList。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。
Quuid String 查询指定Quuid主机的信息
示例值:1
Filters.N Array of Filter 过滤条件。
  • IP - String - 是否必填:否 - 主机ip
  • MachineName - String - 是否必填:否 - 主机名称
  • InstanceID - string - 是否必填:否 - 实例ID
  • Name - String - 是否必填:否 - 账户名(模糊匹配)
  • NameStrict - String - 是否必填:否 - 账户名(严格匹配)
  • Uid - uint64 - 是否必填:否 - Uid
  • Guid - uint64 - 是否必填:否 - Guid
  • LoginTimeStart - String - 是否必填:否 - 开始时间,如:2021-01-11
  • LoginTimeEnd - String - 是否必填:否 - 结束时间,如:2021-01-11
  • LoginType - uint64 - 是否必填:否 - 0-不可登录;1-只允许key登录;2只允许密码登录;3-允许key和密码 仅linux
  • OsType - String - 是否必填:否 - windows或linux
  • Status - uint64 - 是否必填:否 - 账号状态:0-禁用;1-启用
  • UserType - uint64 - 是否必填:否 - 账号类型:0访客用户,1标准用户,2管理员用户 仅windows
  • IsDomain - uint64 - 是否必填:否 - 是否域账号:0 不是,1是 仅windows
  • IsRoot - uint64 - 是否必填:否 - 是否Root权限:0 不是,1是 仅linux
  • IsSudo - uint64 - 是否必填:否 - 是否Sudo权限:0 不是,1是 仅linux
  • IsSshLogin - uint64 - 是否必填:否 - 是否ssh登录:0 不是,1是 仅linux
  • ShellLoginStatus - uint64 - 是否必填:否 - 是否shell登录性,0不是;1是 仅linux
  • PasswordStatus - uint64 - 是否必填:否 - 密码状态:1正常 2即将过期 3已过期 4已锁定 仅linux
  • Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 )

  • 示例值:1
    Limit Integer 需要返回的数量,默认为10,最大值为100
    示例值:1
    Offset Integer 偏移量,默认为0。
    示例值:1
    Order String 排序方式,asc升序 或 desc降序
    示例值:asc
    By String 可选排序:[FirstTime|LoginTime|PasswordChangeTime|PasswordDuaTime|PasswordLockDays]

    示例值:LoginTime

    3. 输出参数

    参数名称 类型 描述
    Total Integer 记录总数
    示例值:1
    Users Array of AssetUserBaseInfo 账号列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取账号列表

    输入示例

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

    输出示例

    {
        "Response": {
            "Total": 1,
            "Users": [
                {
                    "MachineIp": "10.0.0.11",
                    "MachineWanIp": "110.84.0.11",
                    "MachineName": "test-name",
                    "OsInfo": "CentOs Bit64",
                    "Uuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                    "Quuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                    "Uid": "1001",
                    "Gid": "1002",
                    "Status": 1,
                    "IsRoot": 1,
                    "LoginType": 1,
                    "LastLoginTime": "2024-10-11 12:23:34",
                    "Name": "test-name",
                    "ProjectId": 1,
                    "UserType": 1,
                    "IsDomain": 1,
                    "IsSudo": 1,
                    "IsSshLogin": 1,
                    "HomePath": "/root",
                    "Shell": "/bin/sh",
                    "ShellLoginStatus": 1,
                    "PasswordChangeTime": "2024-10-11 12:23:34",
                    "PasswordDueTime": "2024-10-11 12:23:34",
                    "PasswordLockDays": 0,
                    "PasswordStatus": 0,
                    "UpdateTime": "2024-10-11 12:23:34",
                    "FirstTime": "2024-10-11 12:23:34",
                    "IsNew": 0,
                    "MachineExtraInfo": {
                        "WanIP": "110.84.0.11",
                        "PrivateIP": "10.0.0.11",
                        "NetworkType": 0,
                        "NetworkName": "vpc-12341234",
                        "InstanceID": "ins-aj28fjz",
                        "HostName": "test-name"
                    }
                }
            ],
            "RequestId": "37b6df34-68f1-4ab8-a3d8-7b89de604c82"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.DateRange 时间区间格式错误。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameterValue 参数取值错误。