API概览

本产品(cloud-siem/2024-12-12)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

账号管理

API

标题

API概述

GetUserConfig 获取用户信息 获取用户信息。

版本升级

API

标题

API概述

CheckUpgradeItem 检查版本升级项 检查版本升级项。
ExecuteUpgrade 执行版本升级 执行版本升级。
ListUpgradeItems 获取版本升级项列表 获取版本升级项列表。

日志管理

API

标题

API概述

UpdateDataStorage 修改日志管理中的日志存储地域 修改日志管理中的日志存储地域。
UpdateDataStorageTtl 修改日志的存储时长 修改日志的存储时长。
UpdateDataStorageDelivery 修改日志投递状态 修改日志投递状态。
ResetDataStorage 重置用户的日志存储 重置用户的日志存储。
GetDataStorage 获取日志管理中用户日志详情 获取日志管理中用户日志详情。

数据源

API

标题

API概述

CreateDataSource 创建数据源 创建数据源。
UpdateDataSource 更新数据源 更新数据源。
RefreshDataSource 刷新数据源 刷新数据源。
DeleteDataSource 删除数据源 删除数据源。
ListDataSources 获取数据源列表 获取数据源列表。
UpdateDataSourceTemplate 更新数据源模版 修改数据源模板。
ListDataSourceTemplates 获取数据源模版列表 查询数据源模板。
CreateLogStore 创建日志库 创建限制性的用户侧存储。
DeleteLogStore 删除日志库 删除LogStore。
ValidateLogStore 校验日志存储 校验日志存储。
ListLogRegions 获取日志服务Region列表 获取所有的区域。
ListLogProjects 获取日志库列表 获取日志项目列表。
ListLogStores 获取日志存储列表 获取日志存储列表。
GetLogTicket 获取日志服务凭证 获取日志凭证。

数据接入

API

标题

API概述

CreateProduct 创建产品 创建产品。
UpdateProduct 更新产品 更新产品。
DeleteProduct 删除产品 删除产品。
ListProducts 获取产品列表 获取产品列表。
CreateVendor 创建厂商 创建厂商。
UpdateVendor 更新厂商 更新厂商。
DeleteVendor 删除厂商 删除厂商。
ListVendors 获取厂商列表 获取厂商列表。
CreateDataIngestion 创建接入策略 创建接入策略。
EnableDataIngestion 启动接入策略 启动接入策略。
DisableDataIngestion 停止接入策略 停止接入策略。
UpdateDataIngestion 更新接入策略 更新接入策略。
DeleteDataIngestion 删除接入策略 删除接入策略。
GetDataBatchIngestion 获取数据批量接入 获取数据批量接入。
UpdateDataBatchIngestion 更新数据批量接入策略 更新数据批量接入。
ListDataIngestions 获取数据接入策略列表 获取数据接入策略列表。
UpdateDataIngestionTemplate 更新数据接入模版 更新接入模板。
ListDataIngestionTemplates 获取数据接入模版列表 查询接入模板。
ListTrafficStatistics 获取流量统计列表 获取流量统计列表。
ExecuteLogQuery 执行日志服务查询 执行数据查询。

数据标准化

API

标题

API概述

CreateNormalizationRule 创建标准化规则 创建标准化规则。
UpdateNormalizationRule 更新标准化规则 更新标准化规则。
DeleteNormalizationRule 删除标准化规则 删除标准化规则。
ValidateNormalizationRule 校验标准化规则 校验标准化规则。
GetNormalizationRule 获取标准化规则信息 获取标准化规则信息。
GetNormalizationSchema 获取标准化Schema 获取标准化Schema。
GetNormalizationRuleVersion 获取标准化规则版本信息 获取标准化规则版本信息。
DeleteNormalizationRuleVersion 删除标准化规则版本 删除标准化规则版本。
SetDefaultNormalizationRuleVersion 设置标准化规则默认版本 设置标准化规则默认版本。
ListNormalizationRuleVersions 获取标准化规则版本列表 获取标准化规则版本列表。
ListNormalizationRules 获取标准化规则列表 获取标准化规则列表。
ListNormalizationFields 获取标准化字段列表 获取标准化字段列表。
ListNormalizationCategories 获取标准化Category列表 获取标准化Category列表。
ListNormalizationRuleCapacities 获取标准化规则安全能力列表 获取标准化规则安全能力列表。
ListNormalizationSchemas 获取标准化Schema列表 获取标准化Schema列表。

数据集

API

标题

API概述

CreateDataSet 创建数据集 创建数据集。
UpdateDataSet 更新数据集 更新数据集。
DeleteDataSet 删除数据集 删除数据集。
ListDataSets 获取数据集列表 获取数据集列表。
UpdateDataSetRecord 更新数据集记录 更新数据集记录。
DeleteDataSetRecord 删除数据集记录 删除数据集记录。
ListDataSetRecords 获取数据集记录列表 获取数据集记录列表。

检测规则

API

标题

API概述

CreateDetectionRule 创建检测规则 创建检测规则。
UpdateDetectionRule 更新检测规则 更新检测规则。
DeleteDetectionRule 删除检测规则 删除检测规则。
ListDetectionRules 获取自定义规则列表 获取检测规则列表。
GetDetectionStatistic 获取检测规则计数 获取检测规则计数。

事件处置

API

标题

API概述

GetIncident 获取事件详情 获取事件详情。
ListIncidents 获取事件列表 获取事件列表。

导出任务

API

标题

API概述

CreateExportTask 创建导出任务 创建导出任务。
GetExportTask 获取导出任务进度 获取导出任务进度。