You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_FINGERPRINT
GetFingerprintUser - 获取用户信息
复制全文
下载 pdf
GetFingerprintUser - 获取用户信息

分页查询指定主机的系统用户资产,包括用户名、UID、登录 Shell 和最近登录信息。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

GetFingerprintUser

要执行的操作,取值:GetFingerprintUser。

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

SortBy
String
否

LastHeartbeatTime

排序字段。支持取值:username(用户名)、last_login_time(最近登录时间)、start_time(开始时间)、update_time(更新时间)、_id。未指定时默认按更新时间倒序排列。

Username
String
否

root

系统用户名,不区分大小写模糊匹配

AgentId
String
否

agent-id-001

主机ID

LastLoginIP
String
否

192.0.2.10

最近登录 IP 地址,精确匹配

PageNumber
Long
是

1

翻页页码,取值范围为 1 及以上

GroupName
String
否

sudo

用户所属用户组名称,模糊匹配

LastLoginTimeEnd
Long
否

1786579199

最近登录时间范围终点,秒级 Unix 时间戳;与 LastLoginTimeStart 同时传入时生效

SortOrder
String
否

Desc

排序顺序

  • Asc 升序排列
  • Desc 降序排列
Ip
String
否

192.0.2.10

主机 IP;支持公网 IP、私网主 IP、IP 列表与公网出口 IP 模糊匹配,IPv4、IPv6 均可

LastLoginTimeStart
Long
否

1786492800

最近登录时间范围起点,秒级 Unix 时间戳;与 LastLoginTimeEnd 同时传入时生效

PageSize
Long
是

20

每页记录数,取值范围为 1~1000

Tags
Array of String
否

["production"]

主机TAG

TopGroupID
String
否

group-id-001

根分组 ID,可通过多级分组查询接口获取;不传时不限制根分组

CloudProviders
Array of String
否

["volc"]

云厂商列表,精确匹配;可选值 volc(火山引擎)、volc_edge(火山边缘云)、ali(阿里云)、tencent(腾讯云)、huawei(华为云)、aws(AWS)、ibm(IBM Cloud)、azure(Azure)、idc(云外主机);不传时不按云厂商筛选

Hostname
String
否

host-001

主机名称

LeafGroupIDs
Array of String
否

["group-id-101","group-id-102"]

叶子分组 ID 列表,可通过多级分组查询接口获取;不传时不限制叶子分组

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Data
Array of Object

--

分页业务数据,具体元素结构见各接口响应声明

PageNumber
Long

1

当前页面

PageSize
Long

20

页面大小

TotalCount
Long

1

全部数据条数

请求示例

POST /?Action=GetFingerprintUser&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "AgentId": "agent-id-001",
  "CloudProviders": [
    "volc"
  ],
  "GroupName": "sudo",
  "Hostname": "host-001",
  "Ip": "192.0.2.10",
  "LastLoginIP": "192.0.2.10",
  "LastLoginTimeEnd": 1786579199,
  "LastLoginTimeStart": 1786492800,
  "LeafGroupIDs": [
    "group-id-101",
    "group-id-102"
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Tags": [
    "production"
  ],
  "TopGroupID": "group-id-001",
  "Username": "root"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetFingerprintUser",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AgentID": "agent-id-001",
        "AgentTags": [
          "production"
        ],
        "EipAddress": "192.0.2.10",
        "Gid": "gid-id-001",
        "GroupName": "example-name",
        "HomeDir": "/home/example",
        "Hostname": "host-001",
        "ID": "resource-id-001",
        "Info": "info-sample",
        "LastLoginIP": "192.0.2.10",
        "LastLoginTime": 1786579199,
        "Password": "password-sample",
        "PrimaryIpAddress": "192.0.2.10",
        "Shell": "shell-sample",
        "StartTime": 1786492800,
        "Sudoers": "sudoers-sample",
        "Uid": "uid-id-001",
        "UpdateTime": 1786579199,
        "Username": "user@example.com"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用。

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.10.30 14:07:38
这个页面对您有帮助吗?
有用
有用
无用
无用