API概览

最近更新时间: 2024-09-03 18:49:46

API版本

V3

告警设置相关接口

接口名称 接口功能
AddEditWarningRules 添加编辑告警策略
DescribeWarningRules 获取告警策略列表

安全合规相关接口

接口名称 接口功能
AddComplianceAssetPolicySetToWhitelist 安全合规忽略资产+检测项列表
AddCompliancePolicyAssetSetToWhitelist 安全合规忽略检测项+资产列表
AddCompliancePolicyItemToWhitelist 安全合规忽略检测项列表
CreateComplianceTask 安全合规创建合规检查任务
CreateExportComplianceStatusListJob 创建一个导出安全合规信息的任务
DeleteComplianceAssetPolicySetFromWhitelist 删除安全合规忽略项, 资产+检测项列表
DeleteCompliancePolicyAssetSetFromWhitelist 删除检测项+资产列表的白名单策略
DeleteCompliancePolicyItemFromWhitelist 安全合规取消忽略检测项列表
DescribeComplianceAssetDetailInfo 安全合规查询某个资产的详情
DescribeComplianceAssetList 安全合规查询某类资产的列表
DescribeComplianceAssetPolicyItemList 安全合规查询某资产下的检测项列表
DescribeCompliancePeriodTaskList 安全合规查询定时任务列表
DescribeCompliancePolicyItemAffectedAssetList 安全合规查询检测项影响的资产列表
DescribeCompliancePolicyItemAffectedSummary 安全合规查询某检测项影响的信息
DescribeComplianceScanFailedAssetList 安全合规查询上次检测失败的资产的列表
DescribeComplianceTaskAssetSummary 安全合规查询上次任务的资产通过率汇总信息
DescribeComplianceTaskPolicyItemSummaryList 安全合规查询上次任务的检测项的汇总信息列表
DescribeComplianceWhitelistItemList 安全合规查询白名单列表
InitializeUserComplianceEnvironment 安全合规初始化用户的合规基线检测环境
ModifyCompliancePeriodTask 安全合规编辑定时任务
ScanComplianceAssets 安全合规重新检测选定的资产
ScanComplianceAssetsByPolicyItem 安全合规用指定的检测项重新检测选定的资产
ScanCompliancePolicyItems 安全合规重新检测选定的检测项
ScanComplianceScanFailedAssets 安全合规重新检测上次检测失败的资产

安全运营-日志分析 相关接口

接口名称 接口功能
CreateSearchTemplate 添加检索模板
DeleteSearchTemplate 删除检索模板
DescribeESAggregations 获取ES字段聚合结果
DescribeESHits 获取ES查询文档列表
DescribeIndexList 获取索引列表
DescribeLogStorageStatistic 获取日志检索容量使用统计
DescribePublicKey 获取公钥
DescribeSearchExportList 导出ES查询文档列表
DescribeSearchLogs 获取历史搜索记录
DescribeSearchTemplates 获取快速检索列表
DescribeSecLogAlertMsg 查询安全日志告警信息
DescribeSecLogCleanSettingInfo 查询安全日志清理设置详情
DescribeSecLogDeliveryClsOptions 查询安全日志投递cls可选项
DescribeSecLogDeliveryClsSetting 查询安全日志投递Cls配置
DescribeSecLogDeliveryKafkaOptions 查询安全日志投递kafka可选项
DescribeSecLogDeliveryKafkaSetting 查询安全日志投递kafka配置
DescribeSecLogJoinObjectList 查询安全日志接入对象列表
DescribeSecLogJoinTypeList 查询安全日志接入列表
DescribeSecLogKafkaUIN 查询安全日志KafkaUIN
ModifySecLogCleanSettingInfo 修改安全日志清理设置信息
ModifySecLogDeliveryClsSetting 更新安全日志-日志投递cls配置
ModifySecLogDeliveryKafkaSetting 更新安全日志投递kafka设置
ModifySecLogJoinObjects 修改安全日志接入对象
ModifySecLogJoinState 修改安全日志接入状态
ModifySecLogKafkaUIN 修改安全日志kafkaUIN
ResetSecLogTopicConfig 重置安全日志主题设置

网络安全相关接口

接口名称 接口功能
AddAndPublishNetworkFirewallPolicyDetail 容器网络创建网络策略添加并发布任务
AddAndPublishNetworkFirewallPolicyYamlDetail 容器网络创建Yaml网络策略并发布任务
AddNetworkFirewallPolicyDetail 容器网络创建网络策略添加任务
AddNetworkFirewallPolicyYamlDetail 容器网络创建Yaml网络策略添加任务
CheckNetworkFirewallPolicyYaml 容器网络创建检查Yaml网络策略任务
ConfirmNetworkFirewallPolicy 容器网络创建网络策略确认任务
CreateNetworkFirewallClusterRefresh 容器网络集群下发刷新任务
CreateNetworkFirewallPolicyDiscover 容器网络集群网络策略创建自动发现任务
CreateNetworkFirewallPublish 容器网络创建网络策略发布任务
CreateNetworkFirewallUndoPublish 容器网络创建网络策略撤销任务
DeleteNetworkFirewallPolicyDetail 容器网络创建网络策略删除任务
DescribeNetworkFirewallAuditRecord 查询集群策略审计列表
DescribeNetworkFirewallClusterList 查询集群策略列表
DescribeNetworkFirewallClusterRefreshStatus 容器网络查询资产任务进度
DescribeNetworkFirewallNamespaceLabelList 查询集群网络空间标签列表
DescribeNetworkFirewallNamespaceList 查询集群网络空间列表
DescribeNetworkFirewallPodLabelsList 查询集群网络pod标签
DescribeNetworkFirewallPolicyDetail 容器网络集群查看策略详情
DescribeNetworkFirewallPolicyDiscover 容器网络查询网络策略自动发现任务进度
DescribeNetworkFirewallPolicyList 查询集群网络策略列表
DescribeNetworkFirewallPolicyStatus 容器网络查询网络策略策略执行状态
DescribeNetworkFirewallPolicyYamlDetail 容器网络集群查看Yaml网络策略详情
UpdateAndPublishNetworkFirewallPolicyDetail 容器网络创建网络策略更新并发布任务
UpdateAndPublishNetworkFirewallPolicyYamlDetail 容器网络更新Yaml网络策略并发布任务
UpdateNetworkFirewallPolicyDetail 容器网络创建网络策略更新任务
UpdateNetworkFirewallPolicyYamlDetail 容器网络更新Yaml网络策略任务

计费相关接口

接口名称 接口功能
DescribeImageAuthorizedInfo 查询镜像授权信息
DescribeProVersionInfo 查询专业版需购买信息
DescribePurchaseStateInfo 查询容器安全服务已购买信息
DescribeSecLogVasInfo 查询安全日志商品信息

资产管理相关接口

接口名称 接口功能
CreateAssetImageScanSetting 添加容器安全镜像扫描设置
CreateAssetImageVirusExportJob 创建本地镜像木马列表导出任务
CreateHostExportJob 创建主机列表导出任务
DeleteMachine 卸载Agent客户端
DescribeABTestConfig 获取用户当前灰度配置
DescribeAgentDaemonSetCmd 查询平行容器安装命令
DescribeAgentInstallCommand 查询agent安装命令
DescribeAssetSyncLastTime 查询资产同步最近时间
DescribeExportJobDownloadURL 查询导出任务下载URL
DescribeExportJobManageList 查询导出任务管理列表
DescribeInspectionReport 查询检查报告
DescribePromotionActivity 查询促销活动
DescribeTcssSummary 查询容器安全概览信息
DescribeUnauthorizedCoresTendency 查询当天未授权核数趋势
ModifyContainerNetStatus 隔离容器网络状态

运行时安全-反弹Shell相关接口

接口名称 接口功能
AddEditReverseShellWhiteList 添加编辑反弹shell白名单
DeleteReverseShellEvents 删除运行时反弹shell事件
DeleteReverseShellWhiteLists 删除运行时反弹shell白名单
DescribeReverseShellDetail 运行时反弹shell事件详细信息
DescribeReverseShellEvents 运行时反弹shell列表
DescribeReverseShellEventsExport 运行时反弹shell列表导出
DescribeReverseShellWhiteListDetail 运行时反弹shell白名单详细信息
DescribeReverseShellWhiteLists 运行时反弹shell白名单列表
ModifyReverseShellStatus 修改反弹shell事件状态

运行时安全-容器逃逸相关接口

接口名称 接口功能
AddEscapeWhiteList 新增逃逸白名单
CreateEscapeEventsExportJob 创建逃逸事件导出异步任务
CreateEscapeWhiteListExportJob 创建逃逸白名单导出任务
DeleteEscapeWhiteList 删除逃逸白名单
DescribeEscapeEventDetail 查询容器逃逸事件详情
DescribeEscapeEventInfo 查询容器逃逸事件列表
DescribeEscapeEventTendency 查询待处理逃逸事件趋势
DescribeEscapeEventTypeSummary 统计容器逃逸各事件类型和待处理事件数
DescribeEscapeEventsExport 查询容器逃逸事件列表导出
DescribeEscapeRuleInfo 查询容器逃逸扫描规则信息
DescribeEscapeSafeState 查询容器逃逸安全状态
DescribeEscapeWhiteList 查询逃逸白名单
ModifyEscapeEventStatus 修改容器逃逸扫描事件状态
ModifyEscapeRule 修改容器逃逸扫描规则信息
ModifyEscapeWhiteList 修改逃逸白名单

运行时安全-木马调用相关接口

接口名称 接口功能
CreateVirusScanAgain 运行时文件查杀重新检测
CreateVirusScanTask 运行时文件查杀一键扫描
DescribeExportJobResult 查询导出任务的结果
DescribeVirusAutoIsolateSampleDetail 查询木马自动隔离样本详情
DescribeVirusAutoIsolateSampleDownloadURL 查询木马自动隔离样本下载链接
DescribeVirusAutoIsolateSampleList 查询木马自动隔离样本列表
DescribeVirusAutoIsolateSetting 查询木马自动隔离设置
DescribeVirusDetail 运行时查询木马文件信息
DescribeVirusEventTendency 查询木马事件趋势
DescribeVirusList 查询运行时文件查杀事件列表
DescribeVirusManualScanEstimateTimeout 查询木马一键检测预估超时时间
DescribeVirusMonitorSetting 运行时查询文件查杀实时监控设置
DescribeVirusSampleDownloadUrl 查询木马样本下载url
DescribeVirusScanSetting 运行时查询文件查杀设置
DescribeVirusScanTaskStatus 运行时查询文件查杀任务状态
DescribeVirusScanTimeoutSetting 运行时文件扫描超时设置查询
DescribeVirusSummary 运行时查询木马概览信息
DescribeVirusTaskList 运行时查询文件查杀任务列表
ExportVirusList 运行时文件查杀事件列表导出
ModifyVirusAutoIsolateExampleSwitch 修改木马自动隔离样本开关
ModifyVirusAutoIsolateSetting 修改木马自动隔离设置
ModifyVirusFileStatus 运行时更新木马文件事件状态
ModifyVirusMonitorSetting 运行时更新文件查杀实时监控设置
ModifyVirusScanSetting 运行时更新文件查杀设置
ModifyVirusScanTimeoutSetting 运行时文件扫描超时设置
StopVirusScanTask 运行时停止木马查杀任务

运行时安全-高危系统调用相关接口

接口名称 接口功能
CreateAbnormalProcessRulesExportJob 创建异常进程规则导出任务
DeleteRiskSyscallEvents 删除运行时高危系统调用事件
DeleteRiskSyscallWhiteLists 删除运行时高危系统调用白名单
DescribeRiskSyscallEvents 运行时高危系统调用列表
DescribeRiskSyscallEventsExport 运行时高危系统调用列表导出
DescribeRiskSyscallNames 运行时高危系统调用系统名称列表
DescribeRiskSyscallWhiteListDetail 运行时高危系统调用白名单详细信息
DescribeRiskSyscallWhiteLists 运行时高危系统调用白名单列表
ModifyRiskSyscallStatus 修改高危系统调用事件状态

运行时安全相关接口

接口名称 接口功能
AddEditAbnormalProcessRule 添加编辑异常进程策略
AddEditAccessControlRule 添加编辑运行访问控制策略
AddEditRiskSyscallWhiteList 添加编辑高危系统调用白名单
CreateDefenceVulExportJob 创建支持防御的漏洞导出任务
CreateEmergencyVulExportJob 创建应急漏洞导出任务
CreateProcessEventsExportJob 创建异常进程事件导出异步任务
CreateRiskDnsEventExportJob 创建恶意请求事件导出任务
CreateSystemVulExportJob 创建系统漏洞导出任务
CreateVulContainerExportJob 创建受漏洞影响的容器导出任务
CreateVulImageExportJob 创建导出受漏洞影响的镜像任务
CreateVulScanTask 创建漏洞扫描任务
CreateWebVulExportJob 创建web漏洞导出任务
DeleteAbnormalProcessRules 删除运行时异常进程策略
DeleteAccessControlRules 删除运行时访问控制策略
DescribeAbnormalProcessDetail 运行时异常进程事件详细信息
DescribeAbnormalProcessEventTendency 查询待处理异常进程事件趋势
DescribeAbnormalProcessEvents 运行时异常进程列表
DescribeAbnormalProcessEventsExport 运行时异常进程列表导出
DescribeAbnormalProcessLevelSummary 统计异常进程各威胁等级待处理事件数
DescribeAbnormalProcessRuleDetail 查询运行时异常进程策略详细信息
DescribeAbnormalProcessRules 运行时异常进程策略列表
DescribeAbnormalProcessRulesExport 运行时异常进程策略列表导出
DescribeAccessControlDetail 运行时访问控制事件详细信息
DescribeAccessControlEvents 运行时访问控制事件列表
DescribeAccessControlEventsExport 运行时访问控制事件列表导出
DescribeAccessControlRuleDetail 查询运行时访问控制策略详细信息
DescribeAccessControlRules 运行时访问控制策略列表
DescribeAccessControlRulesExport 运行时访问控制策略列表导出
DescribeAssetImageBindRuleInfo 镜像绑定规则列表
DescribeEmergencyVulList 查询应急漏洞列表
DescribeRiskDnsEventDetail 查询恶意请求事件详情
DescribeRiskDnsList 查询恶意请求事件列表
DescribeRiskSyscallDetail 运行时高危系统调用事件详细信息
DescribeSupportDefenceVul 查询支持防御的漏洞列表
DescribeVulContainerList 查询受漏洞的容器列表
DescribeVulDetail 查询漏洞详情
DescribeVulImageList 查询漏洞影响的镜像列表
DescribeVulScanInfo 查询漏洞扫描任务信息
DescribeVulScanLocalImageList 查询漏洞扫描任务的本地镜像列表
DescribeWebVulList 查询web应用漏洞列表
ModifyAbnormalProcessRuleStatus 修改运行时异常进程策略状态
ModifyAbnormalProcessStatus 修改异常进程事件状态
ModifyAccessControlRuleStatus 修改运行时访问控制策略状态
ModifyAccessControlStatus 修改运行时访问控制事件状态
OpenTcssTrial 开通容器安全服务试用
StopVulScanTask 停止漏洞扫描任务

镜像安全相关接口

接口名称 接口功能
AddAssetImageRegistryRegistryDetail 新增单个镜像仓库详细信息
AddEditImageAutoAuthorizedRule 新增或编辑本地镜像自动授权规则
AddIgnoreVul 新增漏洞扫描忽略漏洞
CheckRepeatAssetImageRegistry 检查单个镜像仓库名是否重复
CreateAssetImageRegistryScanTask 镜像仓库创建镜像扫描任务
CreateAssetImageRegistryScanTaskOneKey 镜像仓库创建镜像一键扫描任务
CreateAssetImageScanTask 创建镜像扫描任务
CreateComponentExportJob 查询本地镜像组件列表导出
CreateImageExportJob 创建镜像导出任务
CreateOrModifyPostPayCores 创建或者编辑弹性计费上限
CreateVulDefenceEventExportJob 创建漏洞防御导出任务
CreateVulDefenceHostExportJob 创建漏洞防御主机导出任务
CreateVulExportJob 查询本地镜像漏洞列表导出
DeleteIgnoreVul 取消漏洞扫描忽略漏洞
DescribeAssetAppServiceList 查询app服务列表
DescribeAssetComponentList 查询容器组件列表
DescribeAssetContainerDetail 查询容器信息
DescribeAssetContainerList 查询容器列表
DescribeAssetDBServiceList 查询db服务列表
DescribeAssetHostDetail 查询主机信息
DescribeAssetHostList 查询主机列表
DescribeAssetImageDetail 查询镜像信息
DescribeAssetImageHostList 查询镜像关联主机
DescribeAssetImageList 查询镜像列表
DescribeAssetImageListExport 查询镜像列表导出
DescribeAssetImageRegistryAssetStatus 查看镜像仓库资产更新进度状态
DescribeAssetImageRegistryDetail 镜像仓库查询镜像仓库详情
DescribeAssetImageRegistryList 镜像仓库查询镜像仓库列表
DescribeAssetImageRegistryListExport 镜像仓库镜像列表导出
DescribeAssetImageRegistryRegistryDetail 查看单个镜像仓库详细信息
DescribeAssetImageRegistryRegistryList 镜像仓库仓库列表
DescribeAssetImageRegistryRiskInfoList 镜像仓库查询镜像高危行为列表
DescribeAssetImageRegistryRiskListExport 镜像仓库敏感信息列表导出
DescribeAssetImageRegistryScanStatusOneKey 镜像仓库查询一键镜像扫描状态
DescribeAssetImageRegistrySummary 镜像仓库查询镜像统计信息
DescribeAssetImageRegistryVirusList 镜像仓库查询木马病毒列表
DescribeAssetImageRegistryVirusListExport 镜像仓库木马信息列表导出
DescribeAssetImageRegistryVulList 镜像仓库查询镜像漏洞列表
DescribeAssetImageRegistryVulListExport 镜像仓库漏洞列表导出
DescribeAssetImageRiskList 查询镜像风险列表
DescribeAssetImageRiskListExport 镜像风险列表导出
DescribeAssetImageScanSetting 获取镜像扫描设置信息
DescribeAssetImageScanStatus 查询镜像扫描状态
DescribeAssetImageScanTask 查询正在一键扫描的镜像扫描taskid
DescribeAssetImageSimpleList 查询镜像简略信息列表
DescribeAssetImageVirusList 查询镜像病毒列表
DescribeAssetImageVirusListExport 镜像木马列表导出
DescribeAssetImageVulList 查询镜像漏洞列表
DescribeAssetImageVulListExport 镜像漏洞列表导出
DescribeAssetPortList 查询端口占用列表
DescribeAssetProcessList 查询进程列表
DescribeAssetSummary 查询账户容器、镜像等统计信息
DescribeAssetWebServiceList 查询web服务列表
DescribeAutoAuthorizedRuleHost 查询自动授权规则授权范围主机信息
DescribeContainerAssetSummary 查询容器安全资产概览
DescribeContainerSecEventSummary 查询容器安全未处理事件概览
DescribeImageAutoAuthorizedLogList 查询镜像自动授权结果列表
DescribeImageAutoAuthorizedRule 查询本地镜像自动授权规则
DescribeImageAutoAuthorizedTaskList 查询镜像自动授权任务列表
DescribeImageComponentList 查询本地镜像组件列表
DescribeImageRegistryNamespaceList 查询用户镜像仓库下的命令空间列表
DescribeImageRegistryTimingScanTask 镜像仓库查看定时任务
DescribeImageRiskSummary 查询本地镜像风险概览
DescribeImageRiskTendency 查询容器安全本地镜像风险趋势
DescribeImageSimpleList 查询全部镜像列表
DescribeNewestVul 查询最新披露漏洞列表
DescribePostPayDetail 查询后付费详情
DescribeScanIgnoreVulList 查询扫描忽略的漏洞列表
DescribeSecEventsTendency 查询容器运行时安全时间趋势
DescribeSystemVulList 查询系统漏洞列表
DescribeValueAddedSrvInfo 查询增值服务需购买信息
DescribeVulDefenceEvent 查询漏洞防御事件列表
DescribeVulDefenceEventDetail 查询漏洞防御事件详情
DescribeVulDefenceEventTendency 查询漏洞防御攻击事件趋势
DescribeVulDefenceHost 查询漏洞防御的主机列表
DescribeVulDefencePlugin 查询漏洞防御插件列表
DescribeVulDefenceSetting 查询漏洞防御设置信息
DescribeVulIgnoreLocalImageList 查询漏洞扫描忽略的本地镜像列表
DescribeVulIgnoreRegistryImageList 查询漏洞扫描忽略的仓库镜像列表
DescribeVulImageSummary 查询漏洞镜像统计
DescribeVulLevelImageSummary 查询应急漏洞各威胁等级统计镜像数
DescribeVulLevelSummary 查询漏洞各威胁等级统计数
DescribeVulRegistryImageList 查询漏洞影响的仓库镜像列表
DescribeVulScanAuthorizedImageSummary 统计漏洞扫描页已授权和未扫描镜像数
DescribeVulSummary 查询漏洞风险统计概览
DescribeVulTendency 查询漏洞风险趋势
DescribeVulTopRanking 查询漏洞Top排名列表
ModifyAsset 主机资产刷新
ModifyAssetImageRegistryScanStop 镜像仓库停止镜像扫描任务
ModifyAssetImageRegistryScanStopOneKey 镜像仓库停止镜像一键扫描任务
ModifyAssetImageScanStop 停止镜像扫描
ModifyImageAuthorized 批量授权镜像扫描V2.0
ModifyVulDefenceEventStatus 修改漏洞防御事件状态
ModifyVulDefenceSetting 编辑漏洞防御设置
RemoveAssetImageRegistryRegistryDetail 删除单个镜像仓库详细信息
RenewImageAuthorizeState 授权镜像扫描
SwitchImageAutoAuthorizedRule 编辑本地镜像自动授权开关
SyncAssetImageRegistryAsset 镜像仓库资产刷新
UpdateAssetImageRegistryRegistryDetail 更新单个镜像仓库详细信息
UpdateImageRegistryTimingScanTask 镜像仓库更新定时任务

集群安全相关接口

接口名称 接口功能
CreateCheckComponent 安装检查组件
CreateClusterCheckTask 创建集群检查任务
CreateRefreshTask 下发刷新任务
DescribeAffectedClusterCount 获取受影响的集群数量
DescribeAffectedNodeList 查询节点类型的影响范围
DescribeAffectedWorkloadList 查询workload类型的影响范围
DescribeCheckItemList 查询所有检查项接口
DescribeClusterDetail 查询单个集群的详细信息
DescribeClusterSummary 查询用户集群资产总览
DescribeRefreshTask 查询刷新任务
DescribeRiskList 查询集群风险项列表
DescribeTaskResultSummary 查询检查结果总览
DescribeUnfinishRefreshTask 查询未完成的刷新资产任务信息
DescribeUserCluster 用户集群资产查询
SetCheckMode 设置检测模式和自动检查

高级防御-k8sApi异常请求相关接口

接口名称 接口功能
CreateAccessControlsRuleExportJob 创建文件篡改规则导出任务
CreateK8sApiAbnormalEventExportJob 创建k8s api异常事件导出任务
CreateK8sApiAbnormalRuleExportJob 创建k8sApi异常规则导出任务
CreateK8sApiAbnormalRuleInfo 创建k8sapi异常事件规则
DeleteK8sApiAbnormalRule 删除k8sapi异常事件规则
DescribeAssetClusterList 查询集群列表
DescribeK8sApiAbnormalEventInfo 查询k8s api 异常事件详情
DescribeK8sApiAbnormalEventList 查询k8s api异常事件列表
DescribeK8sApiAbnormalRuleInfo 查询k8sapi异常请求规则详情
DescribeK8sApiAbnormalRuleList 查询k8sapi异常请求规则列表
DescribeK8sApiAbnormalRuleScopeList 查询k8sapi 异常规则中范围列表
DescribeK8sApiAbnormalSummary 查询k8sapi异常事件统计
DescribeK8sApiAbnormalTendency 查询k8sapi异常事件趋势
ModifyK8sApiAbnormalEventStatus 修改k8sapi异常事件状态
ModifyK8sApiAbnormalRuleInfo 修改k8sapi异常规则信息
ModifyK8sApiAbnormalRuleStatus 修改k8sapi异常事件规则状态