API概览

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

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

数据审计

API

标题

API概述

DescribeAuditLogs 查询审计告警日志列表 调用本接口查询审计告警日志列表。

服务关联角色

API

标题

API概述

CreateSlrRole 创建服务关联角色 调用CreateSlrRole创建数据安全中心DSC(Data Security Center)的服务关联角色,授权DSC访问云资源。

授权

API

标题

API概述

DeleteDataLimit 删除数据资产扫描授权 调用本接口删除连接授权的库、实例、Bucket数据资产。
DescribeDataLimits 查询数据资产扫描授权列表 调用本接口查询连接授权的实例、库、Bucket数据资产列表。
ModifyDataLimit 修改数据资产扫描授权 调用ModifyDataLimit修改DSC连接授权的配置项。
DescribeDataLimitDetail 查询连接授权单个实例 查询连接授权的单个实例、库、Bucket的详情。
CreateDataLimit 创建数据资产扫描授权 调用CreateDataLimit创建对数据库、项目、存储空间(Bucket)进行扫描的授权。
DescribeDataLimitSet 查询非结构化资产授权列表或数据安全中心支持的地域列表 调用DescribeDataLimitSet接口查询非结构化资产授权列表或数据安全中心支持的地域列表。
DescribeInstanceSources 查询数据资产列表 获取数据资产列表。
DescribeParentInstance 查询未授权或已授权资产列表 调用本接口查询未授权或已授权资产列表。

识别配置

API

标题

API概述

ScanOssObjectV1 创建文件扫描任务 调用ScanOssObjectV1接口为对应存储对象创建敏感数据识别的扫描任务。
CreateScanTask 创建扫描任务 调用CreateScanTask接口为识别权限授权成功的资产创建识别敏感数据的定制化扫描任务。
ModifyDefaultLevel 修改敏感数据的风险等级定义规则 调用本接口修改敏感数据的风险等级定义规则,包括未能识别数据的默认风险等级、归类为“敏感”的数据风险等级。
ModifyRuleStatus 修改识别规则的检测功能状态 调用本接口开启或关闭敏感数据识别规则的检测功能。
ModifyRule 修改自定义的敏感数据识别规则 调用ModifyRule接口修改数据安全中心DSC(Data Security Center)中自定义的敏感数据识别规则。
DeleteRule 删除自定义的敏感数据识别规则 调用本接口删除自定义的敏感数据识别规则。
CreateRule 创建自定义的敏感数据识别规则 调用CreateRule创建自定义的敏感数据识别规则。

数据识别

API

标题

API概述

DescribeRules 查询识别规则的列表 调用本接口查询敏感数据识别规则的列表。
DescribeRiskLevels 查询风险等级列表 调用DescribeRiskLevels接口获取数据识别的风险等级列表。
DescribeDataAssets 查询数据资产敏感信息 执行敏感数据保护概览页面的数据资产搜索。
DescribeInstances 查询数据资产实例列表 获取连接授权的MaxCompute、RDS、OSS数据资产实例列表。
DescribeTables 查询数据资产表的数据 查询数据安全中心连接授权的MaxCompute、RDS等数据资产的表数据。
DescribeColumns 查询数据资产表中列的数据 调用DescribeColumns接口查询数据安全中心连接授权的MaxCompute、RDS等数据资产表中列的数据。
DescribeColumnsV2 查询数据资产表中列的数据V2 调用DescribeColumns接口查询数据安全中心连接授权的MaxCompute、RDS等数据资产表中列的数据。
DescribeOssObjects 查询OSS的存储对象列表 调用本接口查询连接授权的OSS的存储对象列表。
DescribeOssObjectDetail 查询OSS存储对象的详细信息 调用本接口查询数据安全中心连接授权的OSS的单个存储对象的详细信息。
DescribeOssObjectDetailV2 查询OSS存储对象的详细信息V2 调用本接口查询数据安全中心连接授权的OSS的单个存储对象的详细信息
DescribePackages 查询数据包的信息 调用本接口查询已完成扫描授权的MaxCompute数据包的信息,例如数据包的名称、数据包所属者的账号、数据包的风险等级等。
DescribeCategoryTemplateList 查询行业模板列表 调用本接口查询行业模板列表。
DescribeCategoryTemplateRuleList 查询分类分级模板的规则列表 分页获取分类分级模板的规则列表。
DescribeTemplateAllRules 查询行业模板所有模型列表 调用本接口查询行业模板所有模型列表。
DescribeDocTypes 查询支持识别的OSS文件类型列表 调用本接口查询支持识别的OSS文件类型列表。
DescribeDataObjects 查询数据对象列表 调用本接口查询数据表、文件的数据识别结果。
DescribeDataObjectColumnDetail 查询数据对象列详情 调用本接口查询数据表的列识别结果。
DescribeDataObjectColumnDetailV2 查询数据对象列详情V2 调用本接口查询数据表的列识别结果。

安全配置

API

标题

API概述

CreateConfig 修改异常告警通用配置 调用CreateConfig接口修改异常告警通用配置模块的参数。
DescribeConfigs 查询异常告警中配置项的列表 查询异常告警通用配置模块中配置项的列表。
ModifyReportTaskStatus 修改报表任务状态 调用ModifyReportTaskStatus开启或关闭报表任务。
DescribeUserStatus 查询用户账号状态 调用DescribeUserStatus查询用户账号状态。
DisableUserConfig 停用用户配置 调用DisableUserConfig接口停用用户配置。停用用户配置后,可以通过调用CreateConfig接口输入相同的请求参数Code,恢复该配置项编码的异常告警通用配置。

异常告警

API

标题

API概述

ModifyEventTypeStatus 修改检测子类型异常事件状态 调用本接口开启检测子类型异常事件的功能。
ModifyEventStatus 修改异常事件状态 调用本接口处理异常事件。
DescribeEvents 查询异常事件列表 调用本接口查询异常事件列表。
DescribeEventDetail 查询异常事件详情 调用本接口查询单个异常事件详情,包括异常事件发生时间、异常描述及处理状态等。
DescribeEventTypes 查询异常事件类型的列表 调用本接口查询异常事件类型的列表。

数据脱敏

API

标题

API概述

DescribeDataMaskingTasks 查询脱敏任务列表 调用DescribeDataMaskingTasks获取脱敏任务列表。
DescribeDataMaskingRunHistory 查询脱敏任务执行情况 调用DescribeDataMaskingRunHistory查询脱敏任务执行情况。
ExecDatamask 对数据进行动态脱敏 调用ExecDatamask接口对数据进行动态脱敏。
StopMaskingProcess 终止脱敏任务 调用StopMaskingProcess接口终止脱敏任务。终止的脱敏任务,根据唯一资源ID,可通过ManualTriggerMaskingProcess重新开启脱敏任务。
ManualTriggerMaskingProcess 触发一次脱敏任务 调用ManualTriggerMaskingProcess触发一次脱敏任务。

其他

API

标题

API概述

DescribeIdentifyTaskStatus 获取识别任务状态 根据识别任务ID获取任务的完成状态。 识别任务ID可通过调用CreateScanTaskScanOssObjectV1,从返回值中的ID字段来获取。