文档

DescribeAgentlessSensitiveFileByKey - 获取某一类型的敏感文件告警列表

更新时间:

获取无代理检测功能检测出的含有某一敏感文件类型的资产列表。

接口说明

仅支持开通云安全中心无代理检测按量付费的阿里云账号调用该接口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeAgentlessSensitiveFileByKeyget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SensitiveFileKeystring

敏感文件类型。

sshpasswd
Statusstring

基线风险的修复状态。取值:

  • 0:未修复
  • 1:已修复
0
InstanceIdstring

指定要查询的资产实例 ID,可通过任务管理 - 详情 - 检测对象获取。

i-bp1fu4aqltf1huhc****
Remarkstring

资产名称或 IP。

1.2.XX.XX
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
50
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
ScanRangearray

扫描范围集合。

string

单个扫描范围。取值:

  • agentless_image:主机镜像。
  • agentless_snapshot:主机快照。
  • ecs_image:自定义镜像。
  • ecs_snapshot:用户快照。
agentless_image
ImageUuidstring

指定扫描资产的 UUID,可通过主机资产和云产品页面获取。主机安全检测场景下,该参数为扫描主机的 UUID。快照安全检测和自定义镜像安全检测场景下,该参数为扫描镜像/快照的 ID。

06293273b67d19516cfcc712194f****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

FBBEB173-1F43-505F-A876-C03ECDF6CE4C
PageInfoobject

分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的统计信息的数量。

20
TotalCountinteger

查询结果的总数。

100
Countinteger

分页查询时,当前页显示的数据总数量。

20
SensitiveFileListarray<object>

无代理检测敏感文件信息。

SensitiveFileListobject

无代理检测敏感文件信息。

SensitiveFileKeystring

敏感文件类型。

pem
RiskLevelstring

风险等级。取值:

  • high:高危。
  • medium:中危。
  • low:低危。
high
InternetIpstring

无代理检测资产的公网 IP 地址。

95.214.XX.XX
IntranetIpstring

无代理检测资产的私网 IP 地址。

10.68.XX.XX
Uuidstring

无代理检测资产的 UUID。

73e6a851-e63b-49ef-9d7a-5542d765****
TargetNamestring

无代理检测扫描对象名称。

SAS_Agentless_171869952****
Statusinteger

敏感文件状态。取值:

  • 0:未处理。
  • 1:忽略。
  • 2:误报。
0
InstanceNamestring

无代理检测资产的实例名称。

test-server
FirstScanTimelong

首次扫描的时间戳,单位:毫秒。

1663321552000
LastScanTimelong

最新扫描的时间戳,单位:毫秒。

1663691592000
Successboolean

返回的查询结果的状态。取值:

  • true:成功
  • false:失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "FBBEB173-1F43-505F-A876-C03ECDF6CE4C",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "SensitiveFileList": [
    {
      "SensitiveFileKey": "pem",
      "RiskLevel": "high",
      "InternetIp": "95.214.XX.XX",
      "IntranetIp": "10.68.XX.XX",
      "Uuid": "73e6a851-e63b-49ef-9d7a-5542d765****",
      "TargetName": "SAS_Agentless_171869952****",
      "Status": 0,
      "InstanceName": "test-server",
      "FirstScanTime": 1663321552000,
      "LastScanTime": 1663691592000
    }
  ],
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。