文档

API概览

更新时间:
本产品(云安全中心(威胁分析)/2022-06-16)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

多账号管控

API标题API概述
ListRdUsers查看资源目录下用户信息列举已经接入威胁分析多账号管控的阿里云账号,被纳管到威胁分析的阿里云账号才可以使用威胁分析日志接入、事件处置等功能。
AddUser纳管指定云账号将指定云账号添加到威胁分析的多账号管控,只有纳管后的云账号才可以试用日志接入等威胁分析功能。
DeleteUser删除指定云账号的多账号纳管解除已经添加到威胁分析-多账号管控资源目录阿里云账号纳管,如有需要可以重新添加。

日志接入

API标题API概述
BatchJobSubmit按资源目录批量提交产品接入任务支持用户通过资源目录架构配置日志接入任务。
ListAccountsByLog按日志查看账号列表按日志查看账号列表。
DescribeUserBuyStatus查看阿里云用户威胁分析购买情况查看当前阿里云用户或对应的阿里云企业组织账号是否已经购买威胁分析。
SubmitJobs批量提交日志接入批量提交日志接入任务,将对应日志数据接入到威胁分析体系中,进行告警事件分析。
ListProjectLogStores自动查找SLS的LogStore信息根据云产品默认的sls project名字的pattern, logstore名字的pattern查找是否存在对应的project和logstore。
ListUserProdLogs查看日志接入的用户信息根据产品列举用户接入日志的列表。
ModifyDataSource修改数据源修改已经添加的数据源描述信息。
ModifyDataSourceLog修改日志修改数据源下添加的日志相关说明信息。
ModifyBindAccount修改已经绑定的云账号修改已经绑定的云账号。
ListUsersByProd按产品查看已经接入的日志详情按产品查看用户接入的日志详情。
ListImportedLogsByProd查看该产品下日志接入详情查看该产品下日志接入详情。
ListDataSourceTypes枚举数据源类型枚举目前威胁分析支持的多云接入数据源类型。
ListDataSourceLogs查看数据源下的日志列表查看数据源下的日志列表。
ListBindDataSources枚举所有数据源枚举所有数据源。
ListAllProds查看云产品列表查看当前威胁分析已经支持的数据接入的云产品列表。
EnableServiceForCloudSiem开通资源目录权限为威胁分析开通资源目录授权,需要使用资源目录管理员调用。
EnableAccessForCloudSiem创建威胁分析SLR用户授权接口,点击将创建威胁分析角色AliyunServiceRoleForSasCloudSiem。
DescribeServiceStatus查看资源目录是否已给威胁分析授权查看资源目录是否已给威胁分析授权。
DescribeProdCount查看多云产品数量查看阿里云、腾讯云、华为云已经支持接入到威胁分析的云产品数量。
DescribeImportedLogCount查看接入日志的数量查看接入日志的数量。
DescribeDataSourceParameters获取数据源参数详情获取数据源参数详情。
DescribeDataSourceInstance查看数据源详情查看数据源详情。
DescribeAuth检查是否已经开通SIEM权限检查阿里云账号是否已经给SIEM授权,已经创建了AliyunServiceRoleForSasCloudSiem角色。
DeleteDataSourceLog删除日志删除日志。
DeleteDataSource删除数据源如果已添加的数据源不再使用,可以调用接口删除数据源。
DeleteBindAccount删除已经绑定的多云账号解除已经绑定到威胁分析数据源模块的多云(腾讯云、华为云)子账号AK,解绑后可以更换账号重新绑定。
BindAccount绑定多云账号绑定云安全中心功能设置-多云资产中设置的多云账号到威胁分析。
AddUserSourceLogConfig添加日志接入添加日志接入任务,将对应的日志数据接入到威胁分析中以便后续的告警、事件分析。
AddDataSourceLog添加日志添加日志。
AddDataSource添加数据源在该绑定的多云账号下添加数据源。
ListBindAccount列举已经绑定的账号列表列举已经绑定到威胁分析的多云账号列表。
ListAccountAccessId查看已绑定AK列表查看已经绑定的多云AccessKeyId列表。
SubmitImportLogTasks提交接入任务批量提交接入任务。
DescribeCsImportedProdStatusByUser查看用户的阿里云产品开通情况查看阿里云产品的开通情况。

安全告警

API标题API概述
DescribeAlertsWithEntity获取实体关联告警列表获取实体关联的告警列表。
DescribeAlerts获取告警列表获取用户的告警列表。
DescribeAlertSource获取告警数据源列表获取告警数据源列表。
DescribeAlertsCount获取告警不同级别计数获取告警不同级别计数。

事件处置

API标题API概述
DescribeEntityInfo获取实体详情获取实体详情。
PostEventDisposeAndWhiteruleList提交事件处置信息提交事件处置信息。
DescribeWafScope获取作用域用户名下waf实例的域名防护列表获取作用域用户名下waf实例的域名防护列表。
DescribeEventDispose获取事件历史处置策略获取事件历史处置策略。
DescribeEventCountByThreatLevel获取事件各类型计数获取事件各类型计数。
DescribeDisposeAndPlaybook获取需要被处置的实体列表与剧本列表获取需要被处置的实体列表与剧本列表。
DescribeCloudSiemEvents获取事件列表获取siem事件列表。
DescribeCloudSiemEventDetail获取事件详情获取事件详情。
DescribeCloudSiemAssetsCounter获取事件关联各类型资产计数获取事件关联各类型资产计数。
DescribeCloudSiemAssets获取事件关联资产列表获取事件关联资产列表。
DescribeAttackTimeLine获取事件相关的告警时间线数据获取事件相关的告警时间线数据。
DescribeAlertsWithEvent获取事件关联的告警列表获取指定事件关联的告警列表。
DescribeAlertSourceWithEvent获取事件关联告警数据源列表获取事件关联告警数据源列表。

日志分析

API标题API概述
GetLogs获取威胁分析查询分析的日志数据返回日志分析中查询分析SQL语句执行的结果。
GetHistograms获取威胁分析日志查询分析结果的直方图数据返回查询分析SQL执行结果的数据直方图数据,可以用来在前端渲染直方图展示。
DoQuickField使用快速分析字段进行分析普通成员登录看到的日志分析页面中,可以通过左侧的快速分析字段进行查询分析。
ListQuickQuery获取快速查询的列表获取日志分析页面针对当前LogStore的所有快速查询列表。
GetQuickQuery获取快速查询的SQL语句根据自定义的快速查询名字,获取日志分析中存储的快速查询分析SQL语句。
SaveQuickQuery保存当前查询分析语句为快速查询将日志分析中的查询分析SQL语句保存为快速查询,节省SQL书写时间。
DescribeLogStore返回用户存储的相关属性返回用户侧日志服务中威胁分析使用的LogStore的相关属性,如名字、TTL等。
ShowQuickAnalysis展示快速分析字段列表在日志分析中展示能够用来进行快速分析(索引字段)的字段列表。

规则管理

API标题API概述
DescribeAlertType获取自定义规则可选威胁类型列表获取自定义规则可选威胁类型列表。
DeleteCustomizeRule删除自定义规则根据指定ID自定义规则。
DescribeAggregateFunction获取自定义规则聚合函数列表获取自定义规则支持的聚合函数列表。
DescribeCustomizeRuleCount获取自定义规则计数获取自定义规则计数。
DescribeCustomizeRuleTest获取模拟测试场景下的历史模拟数据获取模拟测试场景下的历史模拟数据。
DescribeCustomizeRuleTestHistogram获取自定义规则业务测试结果图表获取自定义规则业务测试结果图表。
DescribeLogFields获取自定义规则可配置字段列表获取自定义规则可配置字段列表。
DescribeLogSource获取自定义规则可配置日志源列表获取自定义规则可配置日志源列表。
DescribeLogType获取自定义规则可配置日志类型获取自定义规则可配置日志类型。
DescribeOperators获取自定义规则操作符列表获取自定义规则操作符列表。
ListCloudSiemCustomizeRules获取自定义规则列表获取自定义规则列表。
ListCloudSiemPredefinedRules获取预定义规则列表获取预定义规则列表。
ListCustomizeRuleTestResult获取自定义规则测试结果列表获取自定义规则测试结果列表。
PostCustomizeRule添加或者更新自定义规则添加或者更新自定义规则。
PostCustomizeRuleTest提交自定义规则测试提交自定义规则测试。
PostFinishCustomizeRuleTest结束自定义规则测试结束自定义规则测试。
PostRuleStatusChange更新自定义规则状态更新自定义规则状态。

响应规则

API标题API概述
DescribeScopeUsers获取剧本作用域用户列表获取剧本作用域用户列表。
DeleteAutomateResponseConfig删除自动化响应规则删除指定ID的自动化响应规则。
DescribeAutomateResponseConfigCounter获取自动化响应规则计数获取自动化响应规则计数。
DescribeAutomateResponseConfigFeature获取自动化规则策略可配置字段及操作符获取自动化规则策略可配置字段及操作符。
DescribeAutomateResponseConfigPlayBooks获取用户自定义剧本列表获取用户自定义剧本列表。
ListAutomateResponseConfigs获取自动化响应规则列表获取自动化响应规则列表。
PostAutomateResponseConfig添加或更新自动化响应规则添加或更新自动化响应规则。
UpdateAutomateResponseConfigStatus更新自动化响应规则状态更新自动化响应规则状态。

处置中心

API标题API概述
ListDisposeStrategy获取处置策略列表获取处置策略列表。
DescribeDisposeStrategyPlaybook获取处置策略使用的剧本列表获取处置策略使用的剧本列表。

权限管理

API标题API概述
ListOperation获取当前登录用户拥有的资源权限获取当前登录用户所具备的资源操作权限,威胁分析服务存在两种身份,管理员和普通成员,管理员具备所有权限,普通成员只能访问受限资源。
DoSelfDelegate是否允许某个普通成员获取告警、日志分析等资源的权限威胁分析管理员对普通成员进行授权和取消授权的操作,使之能够查看或者取消查看日志分析、告警等资源。

存储管理

API标题API概述
RestoreCapacity置空已有的存储释放存储空间,降低存储使用量,注意,该操作不可逆,存在数据丢失的风险,谨慎使用。
GetCapacity获取当前企业威胁分析存储的使用量及购买量获取当前威胁分析存储的使用量以及预付费的购买量,单位为GB。
SetStorage保存用户设置的存储信息保存用户设置的存储天数,存储地域(region)等信息。
DescribeStorage判断威胁分析用户的存储是否存在判断威胁分析用户的存储(用户侧日志服务中LogStore)是否正常。
GetStorage获取设置的存储信息获取威胁分析与响应产品在用户SLS中创建的存储设置,包含存储天数、存储地域等信息。

投递管理

API标题API概述
ListDelivery展示接入威胁分析的日志投递状态查看整个企业或者普通成员接入威胁分析的产品、日志列表,以及这些日志的数据投递情况。
OpenDelivery开通日志的投递开通已经接入产品日志的投递。
CloseDelivery关闭威胁分析已接入的云产品日志的投递关闭某个已经接入的云产品日志的投递,关闭后用户侧的LogStore里不再有对应日志的新内容。

告警加白

API标题API概述
UpdateWhiteRuleList添加或更新告警加白规则添加或更新告警加白规则。
PostEventWhiteruleList提交告警加白规则提交告警加白规则。
DescribeWhiteRuleList获取告警加白规则列表获取告警加白规则列表。
DescribeAlertScene获取告警加白规则场景列表获取告警加白场景。
DescribeAlertSceneByEvent获取告警加白场景与加白对象列表获取告警加白场景与加白对象列表。
DeleteWhiteRuleList删除告警加白规则删除指定ID的告警加白规则。

其他

API标题API概述
DescribeJobStatus检查任务接入状态按提交任务生成的submitId获取接入任务的状态。
  • 本页导读 (1)