调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetFingerprintPort	要执行的操作，取值：GetFingerprintPort。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
CloudProviders	Array of String	否	["volcengine"]	云厂商
AgentId	String	否	agent-id-001	主机ID
Tags	Array of String	否	["production"]	主机TAG
TopGroupID	String	否	group-id-001	根分组 ID，可通过多级分组查询接口获取；不传时不限制根分组
Ip	String	否	192.0.2.10	IP
LeafGroupIDs	Array of String	否	["group-id-101","group-id-102"]	叶子分组 ID 列表，可通过多级分组查询接口获取；不传时不限制叶子分组
Cmdline	String	否	ls -la	完整命令行
Comm	String	否	sshd	进程名称
ContainerId	String	否	container-id-001	ContainerId 标识值，可从对应资源列表接口获取
Exe	String	否	/var/log/example.log	可执行文件路径
Hostname	String	否	host-001	主机名称
Sip	String	否	192.0.2.10	源 IP 地址
Sport	String	否	8080	源端口
Type	Array of Long	否	[6,17]	协议类型列表：6 表示 TCP，17 表示 UDP；不传时不按协议筛选
Username	String	否	user@example.com	Username 名称
PageNumber	Long	是	1	翻页页码，取值范围为 1 及以上
PageSize	Long	是	20	每页记录数，取值范围为 1~5000
SortBy	String	否	LastHeartbeatTime	排序字段；不传时使用接口默认排序
SortOrder	String	否	Desc	排序顺序 Asc 升序排列 Desc 降序排列

返回参数

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

参数	类型	示例值	描述
TotalCount	Long	1	全部数据条数
PageNumber	Long	1	当前页面
PageSize	Long	20	页面大小
Data	Array of Object	--	分页业务数据，具体元素结构见各接口响应声明

请求示例

POST /?Action=GetFingerprintPort&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": [
    "volcengine"
  ],
  "Cmdline": "ls -la",
  "Comm": "sshd",
  "ContainerId": "container-id-001",
  "Exe": "/var/log/example.log",
  "Hostname": "host-001",
  "Ip": "192.0.2.10",
  "LeafGroupIDs": [
    "group-id-101",
    "group-id-102"
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "Sip": "192.0.2.10",
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Sport": "8080",
  "Tags": [
    "production"
  ],
  "TopGroupID": "group-id-001",
  "Type": [
    6,
    17
  ],
  "Username": "user@example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetFingerprintPort",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AgentID": "agent-id-001",
        "AgentTags": [
          "production"
        ],
        "Cmdline": "ls -la",
        "Comm": "bash",
        "ContainerID": "container-id-001",
        "ContainerName": "example-name",
        "Dip": "192.0.2.10",
        "Dport": "443",
        "EipAddress": "192.0.2.10",
        "Exe": "/usr/bin/bash",
        "Family": "IPv4",
        "Hostname": "host-001",
        "ID": "resource-id-001",
        "Inode": "inode-sample",
        "Interface": "interface-sample",
        "Pid": "pid-id-001",
        "PrimaryIpAddress": "192.0.2.10",
        "Sip": "192.0.2.10",
        "Sport": "443",
        "StartTime": 1786492800,
        "State": "LISTEN",
        "Type": 6,
        "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.	不允许的操作，请检查当前资源是否被占用。
403	OperationDenied.TenantUnauthorized(%s)	The request has failed due to tenant not found(%s)	未授权的租户操作
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:37

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码