@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,878 lines (2,877 loc) • 219 kB
TypeScript
/**
* DescribeRuleList返回参数结构体
*/
export interface DescribeRuleListResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据资产报告-涉敏top的资产
*/
export interface TopAsset {
/**
* 分级名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelName?: string;
/**
* top数据信息
注意：此字段可能返回 null，表示取不到有效值。
*/
TopStat?: Array<TopAssetStat>;
}
/**
* DescribeDSPADiscoveryTaskTables返回参数结构体
*/
export interface DescribeDSPADiscoveryTaskTablesResponse {
/**
* 分类分级扫描表集合
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<DSPATableInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCOSAssetSensitiveDistribution返回参数结构体
*/
export interface DescribeCOSAssetSensitiveDistributionResponse {
/**
* cos的涉敏资产
注意：此字段可能返回 null，表示取不到有效值。
*/
CosAsset?: CosAsset;
/**
* 涉敏top
注意：此字段可能返回 null，表示取不到有效值。
*/
TopAsset?: Array<TopAsset>;
/**
* cos资产详情列表
注意：此字段可能返回 null，表示取不到有效值。
*/
CosDetail?: Array<AssetCosDetail>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDSPAAssessmentRiskTemplate请求参数结构体
*/
export interface ModifyDSPAAssessmentRiskTemplateRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 模板名称
*/
TemplateName: string;
/**
* 模板的描述
*/
TemplateDescription: string;
/**
* 模板id
*/
TemplateId: number;
/**
* 修改的风险等级id
*/
RiskLevelId: number;
/**
* 脆弱项列表
*/
RiskIdList?: Array<number | bigint>;
}
/**
* DSPA评估控制项
*/
export interface AssessmentControlItem {
/**
* 评估项Id
*/
ItemId?: string;
/**
* 评估项名称
*/
ItemName?: string;
/**
* 评估项描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
/**
* 评估项来源，内置/用户自定，取值（system，user）
*/
Source?: string;
/**
* 评估项类型，问卷/自动化，取值（questionnaire，auto）
*/
ItemType?: string;
/**
* 评估项子类型，单选/多选/时间/文本/AKSK等，取值（singlechoice，multichoice，date，text，AKSK……等）
*/
ItemSubType?: string;
/**
* 评估项创建时间
*/
CreatedTime?: string;
/**
* 评估项启用状态，启用/未启用，取值draft / launched
*/
Status?: string;
/**
* 评估项关联的模板数量
注意：此字段可能返回 null，表示取不到有效值。
*/
TemplateCount?: number;
}
/**
* DescribeESAssetSensitiveDistribution返回参数结构体
*/
export interface DescribeESAssetSensitiveDistributionResponse {
/**
* ES的资产统计数据
注意：此字段可能返回 null，表示取不到有效值。
*/
ESAsset?: ESAsset;
/**
* 涉敏top数据
注意：此字段可能返回 null，表示取不到有效值。
*/
TopAsset?: Array<TopAsset>;
/**
* ES的详情列表
注意：此字段可能返回 null，表示取不到有效值。
*/
ESDetail?: Array<ESAssetDBDetail>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPARDBDataAssetDetail返回参数结构体
*/
export interface DescribeDSPARDBDataAssetDetailResponse {
/**
* RDB关系数据库敏感数据资产详情列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Details?: Array<DspaRDBDataAssetDetail>;
/**
* 符合条件的RDB关系数据库敏感数据资产数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建评估任务的ES详情
*/
export interface ESInstance {
/**
* 数据源id
*/
DataSourceId: string;
/**
* 数据源类型
*/
DataSourceType: string;
/**
* 地域
*/
ResourceRegion: string;
/**
* 扫描任务ID
*/
DiscoveryTaskId?: number;
/**
* 扫描任务实例ID
*/
DiscoveryTaskInstanceID?: number;
}
/**
* CreateDSPACategory请求参数结构体
*/
export interface CreateDSPACategoryRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 敏感数据分类名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
Name: string;
}
/**
* ModifyDSPATaskResult返回参数结构体
*/
export interface ModifyDSPATaskResultResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPAAssessmentRiskLevelDetail返回参数结构体
*/
export interface DescribeDSPAAssessmentRiskLevelDetailResponse {
/**
* 风险级别名称
*/
RiskLevelName?: string;
/**
* 风险级别描述
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskLevelDescription?: string;
/**
* 分类分级id
注意：此字段可能返回 null，表示取不到有效值。
*/
IdentifyComplianceId?: number;
/**
* 分类分级模板名称
*/
IdentifyComplianceName?: string;
/**
* 风险数据
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskLevelMatrix?: Array<RiskLevelMatrix>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPADiscoveryServiceStatus请求参数结构体
*/
export interface DescribeDSPADiscoveryServiceStatusRequest {
/**
* DSPA实例ID
*/
DspaId: string;
}
/**
* DescribeExportTaskResult返回参数结构体
*/
export interface DescribeExportTaskResultResponse {
/**
* 导出任务结果
*/
ExportResult?: string;
/**
* 导出文件地址
*/
ExportFileUrl?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 敏感识别任务RDB数据规则
*/
export interface ScanTaskRDBRules {
/**
* 规则状态；0 不启用, 1 启用
*/
Status: number;
/**
* 只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一
*/
MatchOperator: string;
/**
* 字段名包含规则，最大支持选择9项
*/
MetaRule: DataRules;
/**
* 内容包含规则，最大支持选择9项
*/
ContentRule: DataRules;
}
/**
* CreateDSPADiscoveryTask返回参数结构体
*/
export interface CreateDSPADiscoveryTaskResponse {
/**
* 任务ID
*/
TaskId: number;
/**
* 扫描结果ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ResultId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPACategoryTree请求参数结构体
*/
export interface DescribeDSPACategoryTreeRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 合规组id
*/
ComplianceId: number;
}
/**
* DeleteCosMetaResource请求参数结构体
*/
export interface DeleteCosMetaResourceRequest {
/**
* 实例Id。
*/
DspaId: string;
/**
* 资源所处地域。
*/
ResourceRegion: string;
/**
* 资源实例ID。
*/
ResourceIds?: Array<string>;
}
/**
* 扫描规则内容
*/
export interface DataContent {
/**
* 规则内容，可以是正则规则，关键词，
忽略词扥
*/
RuleContent: string;
/**
* 是否区分大小写
false: 不区分大小写
true:区分大小写
*/
IsIgnoreCase?: boolean;
}
/**
* DescribeDSPAAssessmentLatestRiskDetailInfo请求参数结构体
*/
export interface DescribeDSPAAssessmentLatestRiskDetailInfoRequest {
/**
* dspa实例Id
*/
DspaId: string;
/**
* 评估模板id
*/
TemplateId: number;
/**
* 风险id
*/
RiskId: number;
}
/**
* DescribeReportTaskDownloadUrl请求参数结构体
*/
export interface DescribeReportTaskDownloadUrlRequest {
/**
* 任务id
*/
ReportTaskId: number;
/**
* dspa实例id
*/
DspaId: string;
/**
* 是否同时下载敏感资产详情报告
*/
IsWithSensitiveDetailReport?: boolean;
}
/**
* 数据样本
*/
export interface DspaFieldResultDataSample {
/**
* 数据样本
注意：此字段可能返回 null，表示取不到有效值。
*/
DataSample: string;
}
/**
* ModifyClassificationRule请求参数结构体
*/
export declare type ModifyClassificationRuleRequest = null;
/**
* DescribeDSPADiscoveryServiceStatus返回参数结构体
*/
export interface DescribeDSPADiscoveryServiceStatusResponse {
/**
* 分类分级服务是否开通，true 表示已开通，false表示未开通
*/
ServiceEnabled: boolean;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRuleDetail返回参数结构体
*/
export interface DescribeRuleDetailResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* COS元数据信息
*/
export interface DSPACosMetaDataInfo {
/**
* COS桶名
*/
Bucket: string;
/**
* COS桶创建时间
*/
CreateTime: string;
/**
* 1 -- 有效，0 -- 无效，资源可能已被删除。
*/
Valid: number;
/**
* DSPA为COS资源生成的资源ID
*/
ResourceId: string;
/**
* COS资源所处的地域
*/
ResourceRegion: string;
/**
* COS桶绑定状态
*/
BindStatus?: string;
/**
* COS桶存储量
*/
Storage?: number;
}
/**
* DSPA评估模版
*/
export interface AssessmentTemplate {
/**
* id
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: number;
/**
* 评估模板Id
*/
TemplateId?: string;
/**
* 评估模板名称
*/
TemplateName?: string;
/**
* 描述信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
/**
* 模板来源，内置/用户自定，取值（system，user）
*/
Source?: string;
/**
* 模板类型，自动化/半自动化/问卷，取值（auto，semi-auto，law）等
*/
UseType?: string;
/**
* 评估模板创建时间
*/
CreatedTime?: string;
/**
* 模板关联的评估项数量
*/
ControlItemCount?: number;
/**
* 模板已启用的评估项数量
*/
AppliedItemCount?: number;
/**
* 模板启用状态，草稿/已启用，取值draft / launched
*/
Status?: string;
/**
* 支持的数据源类型
注意：此字段可能返回 null，表示取不到有效值。
*/
SupportDataSource?: Array<string>;
/**
* 是否包含攻击面风险
注意：此字段可能返回 null，表示取不到有效值。
*/
IsASMTemplate?: boolean;
/**
* 合规组id
注意：此字段可能返回 null，表示取不到有效值。
*/
IdentifyComplianceId?: number;
}
/**
* ModifyDSPATaskResult请求参数结构体
*/
export interface ModifyDSPATaskResultRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 字段扫描结果ID
*/
FieldResultId: number;
/**
* 合规组ID
*/
ComplianceId: number;
/**
* 是否设置为非敏感字段
*/
IsSetNonSensitiveField?: boolean;
/**
* 调整后新的规则ID
*/
DestRuleId?: number;
/**
* 调整后新的分类ID
*/
DestCategoryId?: number;
/**
* 调整后新的分级ID
*/
DestLevelId?: number;
/**
* 调整前的规则ID
*/
SrcRuleId?: number;
/**
* 调整之前的分类id
*/
SrcCategoryId?: number;
/**
* 调整之前的分级id
*/
SrcLevelId?: number;
/**
* 识别方式
0-系统识别，1-人工打标
*/
IdentifyType?: number;
}
/**
* rdb的资产统计结果
*/
export interface RDBAsset {
/**
* DB总数量
注意：此字段可能返回 null，表示取不到有效值。
*/
DbNums?: number;
/**
* 敏感DB数量
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveDbNums?: number;
/**
* 表数量
注意：此字段可能返回 null，表示取不到有效值。
*/
TableNums?: number;
/**
* 敏感表的数量
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveTableNums?: number;
/**
* 字段数量
注意：此字段可能返回 null，表示取不到有效值。
*/
FieldNums?: number;
/**
* 敏感的字段数量
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveFieldNums?: number;
}
/**
* DescribeAssetOverview返回参数结构体
*/
export interface DescribeAssetOverviewResponse {
/**
* 数据库实例id
注意：此字段可能返回 null，表示取不到有效值。
*/
DBInstanceNums?: number;
/**
* 数据库个数
注意：此字段可能返回 null，表示取不到有效值。
*/
DBNums?: number;
/**
* 表的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
TableNums?: number;
/**
* 字段个数
注意：此字段可能返回 null，表示取不到有效值。
*/
FieldNums?: number;
/**
* 数据库实例的分布情况
注意：此字段可能返回 null，表示取不到有效值。
*/
DBInstanceDistribution?: Array<Note>;
/**
* db分布情况
注意：此字段可能返回 null，表示取不到有效值。
*/
DBDistribution?: Array<Note>;
/**
* cos桶的数量
注意：此字段可能返回 null，表示取不到有效值。
*/
BucketNums?: number;
/**
* 文件个数
注意：此字段可能返回 null，表示取不到有效值。
*/
FileNums?: number;
/**
* 用于对用户进行提示信息
注意：此字段可能返回 null，表示取不到有效值。
*/
Remark?: string;
/**
* es实例数量
注意：此字段可能返回 null，表示取不到有效值。
*/
EsInstanceNums?: number;
/**
* es索引数量
注意：此字段可能返回 null，表示取不到有效值。
*/
EsIndexNums?: number;
/**
* es字段数量
注意：此字段可能返回 null，表示取不到有效值。
*/
EsFieldNums?: number;
/**
* mongo实例数量
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoInstanceNums?: number;
/**
* mongo数据库数量
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoDbNums?: number;
/**
* mongo集合数量
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoColNums?: number;
/**
* mongo字段数量
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoFieldNums?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 报表信息
*/
export interface ReportInfo {
/**
* 任务id
*/
Id?: number;
/**
* 报告名称
*/
ReportName?: string;
/**
* 报告类型（AssetSorting:资产梳理）
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportType?: string;
/**
* 报告周期（0单次 1每天 2每周 3每月）
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportPeriod?: number;
/**
* 执行计划 （0:单次报告 1:定时报告）
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportPlan?: number;
/**
* 报告导出状态（Success 成功, Failed 失败, InProgress 进行中）
注意：此字段可能返回 null，表示取不到有效值。
*/
ReportStatus?: string;
/**
* 任务下次启动时间
注意：此字段可能返回 null，表示取不到有效值。
*/
TimingStartTime?: string;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 完成时间
注意：此字段可能返回 null，表示取不到有效值。
*/
FinishedTime?: string;
/**
* 子账号uin
注意：此字段可能返回 null，表示取不到有效值。
*/
SubUin?: string;
/**
* 失败信息
注意：此字段可能返回 null，表示取不到有效值。
*/
FailedMessage?: string;
/**
* 是否启用（0：否 1：是）
注意：此字段可能返回 null，表示取不到有效值。
*/
Enable?: number;
/**
* 识别模板名称
注意：此字段可能返回 null，表示取不到有效值。
*/
ComplianceName?: string;
/**
* 进度百分比
注意：此字段可能返回 null，表示取不到有效值。
*/
ProgressPercent?: number;
}
/**
* DescribeDSPAESDataAssetByComplianceId请求参数结构体
*/
export interface DescribeDSPAESDataAssetByComplianceIdRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 合规组id
*/
ComplianceId: number;
}
/**
* ModifyLevelName请求参数结构体
*/
export declare type ModifyLevelNameRequest = null;
/**
* ModifyDSPAAssessmentRiskLevel返回参数结构体
*/
export interface ModifyDSPAAssessmentRiskLevelResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* COS敏感数据扫描任务相关信息
*/
export interface DspaCOSDiscoveryTask {
/**
* 任务名称
*/
Name: string;
/**
* 任务描述
*/
Description: string;
/**
* 执行周期，0单次 1每天 2每周 3每月
*/
Period: number;
/**
* 执行计划，0立即 1定时
*/
Plan: number;
/**
* 任务开关；1 打开，0 关闭
*/
Enable: number;
/**
* 数据源对象信息
*/
DataSourceInfo: DspaCOSDiscoveryTaskDataSourceInfo;
/**
* 通用规则集开关，0 关闭，1 启用
*/
GeneralRuleSetEnable: number;
/**
* 任务最新的一次执行结果信息，该字段用于查询任务列表接口
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: ScanTaskResult;
/**
* 定时开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
TimingStartTime: string;
/**
* 关联分类模板是否更新
注意：此字段可能返回 null，表示取不到有效值。
*/
ComplianceUpdate: boolean;
}
/**
* COS敏感数据识别规则
*/
export interface COSDataRule {
/**
* 只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一.
默认值为or
*/
Operator?: string;
/**
* 规则内容
*/
Contents?: Array<DataContent>;
}
/**
* DSPA数据源的数据库信息
*/
export interface DSPADataSourceDbInfo {
/**
* 数据库名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DbName: string;
}
/**
* DescribeMongoAssetSensitiveDistribution返回参数结构体
*/
export interface DescribeMongoAssetSensitiveDistributionResponse {
/**
* mongo的资产统计数据
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoAsset?: MongoAsset;
/**
* 涉敏top数据
注意：此字段可能返回 null，表示取不到有效值。
*/
TopAsset?: Array<TopAsset>;
/**
* mongo的详情列表
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoDetail?: Array<MongoAssetDBDetail>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模板详情
*/
export interface ComplianceGroupDetail {
/**
* 模板id
*/
Id?: number;
/**
* 模板名称
*/
Name?: string;
/**
* 描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
/**
* 模板类型
注意：此字段可能返回 null，表示取不到有效值。
*/
ComplianceGroupType?: number;
/**
* 模板分级方案id
*/
LevelGroupId?: number;
/**
* 模板分级方案名称
*/
LevelGroupName?: string;
/**
* 创建时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间
注意：此字段可能返回 null，表示取不到有效值。
*/
ModifyTime?: string;
/**
* 是否开启别名
注意：此字段可能返回 null，表示取不到有效值。
*/
IsAlias?: boolean;
}
/**
* ModifyDSPACOSDiscoveryTask返回参数结构体
*/
export interface ModifyDSPACOSDiscoveryTaskResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindDSPAResourceDatabases返回参数结构体
*/
export interface BindDSPAResourceDatabasesResponse {
/**
* 绑定结果数组
*/
DbTaskResults?: Array<DbTaskResult>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* database批量操作返回结果结构体
*/
export interface DbTaskResult {
/**
* 结果类型。
*/
Result?: string;
/**
* 结果描述。
*/
ResultDescription?: string;
/**
* 错误信息描述。
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrDescription?: ErrDescription;
/**
* 资源ID。
*/
ResourceId?: string;
/**
* database名称。
*/
DbName?: string;
}
/**
* 数据资产报告-rdb的敏感数据规则分布
*/
export interface RuleDistribution {
/**
* 规则id
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId?: number;
/**
* 规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName?: string;
/**
* 分级id
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelId?: number;
/**
* 分级名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelName?: string;
/**
* 规则数量
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleCnt?: number;
}
/**
* DecribeSuggestRiskLevelMatrix返回参数结构体
*/
export interface DecribeSuggestRiskLevelMatrixResponse {
/**
* 矩阵
*/
SuggestRiskLevelMatrix?: Array<SuggestRiskLevelMatrix>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateDSPASelfBuildResource返回参数结构体
*/
export interface UpdateDSPASelfBuildResourceResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPAAssessmentRiskDealedTrend返回参数结构体
*/
export interface DescribeDSPAAssessmentRiskDealedTrendResponse {
/**
* 趋势统计结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<RiskDealedTrendItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRDBAssetSensitiveDistribution请求参数结构体
*/
export interface DescribeRDBAssetSensitiveDistributionRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 合规组id
*/
ComplianceId: number;
/**
* 查询的资产信息列表
*/
AssetList: Array<AssetList>;
}
/**
* GetResourceConnectionStatus请求参数结构体
*/
export interface GetResourceConnectionStatusRequest {
/**
* DSPA实例ID。
*/
DspaId: string;
/**
* 资源类型。
*/
MetaType: string;
/**
* 资源所处地域。
*/
ResourceRegion: string;
/**
* 资源列表中展示的资源ID。
*/
ResourceId: string;
}
/**
* DisableDSPAMetaResourceAuth请求参数结构体
*/
export interface DisableDSPAMetaResourceAuthRequest {
/**
* DSPA实例ID。
*/
DspaId: string;
/**
* 资源类型。
*/
MetaType: string;
/**
* 资源所处地域。
*/
ResourceRegion: string;
/**
* 用户云资源ID列表。
*/
ResourceIDs: Array<string>;
}
/**
* 用于生成默认的风险级别矩阵
*/
export interface RiskMatrixLevel {
/**
* 名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 就是id
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: number;
/**
* 分数
注意：此字段可能返回 null，表示取不到有效值。
*/
Score?: number;
}
/**
* 数据资产报告页面-用户查询入参
*/
export interface AssetList {
/**
* 数据源类型
*/
DataSourceType: string;
/**
* 数据源信息
*/
DataSourceInfo: Array<DataSourceInfo>;
}
/**
* CreateAssetSortingReportTask请求参数结构体
*/
export interface CreateAssetSortingReportTaskRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 识别模板id
*/
ComplianceId: number;
/**
* 选中资产列表
*/
AssetList: Array<AssetList>;
}
/**
* CreateDSPAComplianceGroup返回参数结构体
*/
export interface CreateDSPAComplianceGroupResponse {
/**
* 合规组ID
*/
ComplianceGroupId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDSPADiscoveryTask请求参数结构体
*/
export interface DeleteDSPADiscoveryTaskRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 任务ID
*/
TaskId: number;
/**
* 数据源类型
*/
DataSourceType?: string;
}
/**
* DescribeDSPAAssessmentRiskDatasourceTop5返回参数结构体
*/
export interface DescribeDSPAAssessmentRiskDatasourceTop5Response {
/**
* 无
注意：此字段可能返回 null，表示取不到有效值。
*/
Items: Array<RiskItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDSPADiscoveryTask返回参数结构体
*/
export interface ModifyDSPADiscoveryTaskResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPAAssessmentRiskItemTop5请求参数结构体
*/
export interface DescribeDSPAAssessmentRiskItemTop5Request {
/**
* dspa实例id
*/
DspaId: string;
}
/**
* ModifyDSPAESTaskResult请求参数结构体
*/
export interface ModifyDSPAESTaskResultRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 字段扫描结果ID
*/
FieldResultId: number;
/**
* 合规组ID
*/
ComplianceId: number;
/**
* 是否设置为非敏感字段
*/
IsSetNonSensitiveField?: boolean;
/**
* 调整后新的规则ID
*/
DestRuleId?: number;
/**
* 调整后新的分类ID
*/
DestCategoryId?: number;
/**
* 调整后新的分级ID
*/
DestLevelId?: number;
/**
* 调整前的规则id（系统识别的id）
*/
SrcRuleId?: number;
/**
* 调整前的规则id（系统识别的id）
*/
SrcCategoryId?: number;
/**
* 调整前的等级id
*/
SrcLevelId?: number;
/**
* 0系统识别，1人工打标
*/
IdentifyType?: number;
}
/**
* DescribeDSPACOSDataAssetByComplianceId请求参数结构体
*/
export interface DescribeDSPACOSDataAssetByComplianceIdRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 合规组ID
*/
ComplianceId: number;
}
/**
* CreateDSPAMetaResources返回参数结构体
*/
export interface CreateDSPAMetaResourcesResponse {
/**
* 本次更新的ID号，用来标记一次完整的更新过程。
*/
UpdateId: string;
/**
* 资源类型，支持：cdb（云数据库 MySQL）、dcdb（TDSQL MySQL版）、mariadb（云数据库 MariaDB）、postgres（云数据库 PostgreSQL）、cynosdbpg（TDSQL-C PostgreSQL版）、cynosdbmysql（TDSQL-C MySQL版）
*/
MetaType: string;
/**
* DSPA实例ID。
*/
DspaId: string;
/**
* 资源所处地域。
*/
ResourceRegion: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 扫描任务结果信息
*/
export interface ScanTaskResult {
/**
* 任务最新一次运行结果ID
*/
Id: number;
/**
* 任务扫描结束的时间，格式如：2021-12-12 12:12:12
*/
EndTime: string;
/**
* 任务状态，-1待触发 0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败
*/
Status: number;
/**
* 扫描任务结果展示，如果扫描失败，则显示失败原因
*/
Result: string;
}
/**
* DescribeDSPADiscoveryRules请求参数结构体
*/
export interface DescribeDSPADiscoveryRulesRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 返回上限，默认值10， 最大值10000。
*/
Limit?: number;
/**
* 规则ID
*/
RuleId?: number;
/**
* 规则名称
*/
Name?: string;
/**
* 是否需要过滤别名
*/
FilterRuleSource?: boolean;
}
/**
* RDB关系型数据库敏感数据资产统计
*/
export interface DspaRDBDataAssetCount {
/**
* 数组资产类型，0代表关系型数据库资产，1代表对象存储COS资产
注意：此字段可能返回 null，表示取不到有效值。
*/
DataAssetType: number;
/**
* 已扫描的数据库的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalDbCnt: number;
/**
* 数据库表的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalTableCnt: number;
/**
* 敏感数据类型个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveCategoryCnt: number;
/**
* 敏感字段的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveFieldCnt: number;
/**
* 敏感等级分布
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveLevel: Array<SensitiveLevel>;
/**
* 敏感数据库的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveDbCnt: number;
/**
* 敏感数据库表的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveTableCnt: number;
/**
* 扫描字段的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalFieldCnt: number;
/**
* 数据分类分布
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryDistributed: Array<DspaDataCategoryDistributed>;
}
/**
* DeleteDSPACOSDiscoveryTask请求参数结构体
*/
export interface DeleteDSPACOSDiscoveryTaskRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 任务ID
*/
TaskId: number;
}
/**
* 合规组中规则信息，用于合规组列表中规则信息展示
*/
export interface DspaDiscoveryComplianceGroupRule {
/**
* 敏感数据识别规则ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId: number;
/**
* 敏感数据识别规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName: string;
/**
* 敏感数据分类ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryId: number;
/**
* 敏感数据分级ID, 目前只支持高、中、低三级
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelId: number;
/**
* 合规组对应的分类信息
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryName: string;
/**
* 分级名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelRiskName: string;
}
/**
* CreateDSPAAssessmentTask返回参数结构体
*/
export interface CreateDSPAAssessmentTaskResponse {
/**
* 评估任务Id，格式“task-xxxxxxxx”
*/
TaskId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClassificationRuleCount返回参数结构体
*/
export interface DescribeClassificationRuleCountResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPAESDataAssetByComplianceId返回参数结构体
*/
export interface DescribeDSPAESDataAssetByComplianceIdResponse {
/**
* 概览统计结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Stats?: ESDataAssetCountDto;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDSPAAssessmentRisk请求参数结构体
*/
export interface ModifyDSPAAssessmentRiskRequest {
/**
* DSPA实例Id，格式“dspa-xxxxxxxx”
*/
DspaId: string;
/**
* 评估任务Id，格式“task-xxxxxxxx”
*/
TaskId: string;
/**
* 风险项Id，格式“risk-xxxxxxxx”
*/
RiskId: string;
/**
* 风险项状态。（waiting:待处理，processing:处理中，finished:已处理）
*/
Status: string;
}
/**
* 资源账户信息
*/
export interface DspaResourceAccount {
/**
* 资源ID。
*/
ResourceId: string;
/**
* 用户名。
*/
UserName: string;
/**
* 密码。
*/
Password: string;
}
/**
* 敏感数据扫描任务相关信息
*/
export interface DspaDiscoveryTaskDetail {
/**
* 任务名称
*/
Name: string;
/**
* 任务描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description: string;
/**
* 执行周期，0单次 1每天 2每周 3每月
*/
Period: number;
/**
* 执行计划，0立即 1定时
*/
Plan: number;
/**
* 任务开关；1 打开，0 关闭
*/
Enable: number;
/**
* 元数据对象信息
注意：此字段可能返回 null，表示取不到有效值。
*/
DataSourceInfo: DspaDiscoveryTaskDataSource;
/**
* 通用规则集开关，0 关闭，1 启用
注意：此字段可能返回 null，表示取不到有效值。
*/
GeneralRuleSetEnable: number;
/**
* 当创建任务时，用户打开了通用规则集开关，则该字段就会保存默认合规组信息
注意：此字段可能返回 null，表示取不到有效值。
*/
DefaultComplianceInfo: Array<ScanTaskComplianceInfo>;
/**
* 该任务中用户选择的合规组信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
CustomComplianceInfo: Array<ScanTaskComplianceInfo>;
/**
* 定时开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
TimingStartTime: string;
}
/**
* DeleteDSPAMetaResource返回参数结构体
*/
export interface DeleteDSPAMetaResourceResponse {
/**
* DSPA实例ID。
*/
DspaId: string;
/**
* 删除结果。
*/
Results: Array<DspaTaskResult>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAssetDetailDataExportResult返回参数结构体
*/
export interface DescribeAssetDetailDataExportResultResponse {
/**
* 导出结果
*/
ExportResult: string;
/**
* 导出文件地址
*/
ExportFileUrl: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDSPADiscoveryTaskResult返回参数结构体
*/
export interface DeleteDSPADiscoveryTaskResultResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 扫描任务数据源信息
*/
export interface DspaDiscoveryTaskDataSource {
/**
* 数据源ID
*/
DataSourceId: string;
/**
* 用于传入的数据源的条件，可以选择多个数据库，数据库之间通过逗号分隔，如果为空，默认是全部数据库
*/
Condition: string;
/**
* 代理地址
注意：此字段可能返回 null，表示取不到有效值。
*/
ProxyAddress: Array<string>;
/**
* 数据源名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DataSourceName: string;
/**
* 资源所在地域
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceRegion: string;
}
/**
* DescribeRuleDetail请求参数结构体
*/
export declare type DescribeRuleDetailRequest = null;
/**
* ModifyDSPADiscoveryTask请求参数结构体
*/
export interface ModifyDSPADiscoveryTaskRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 任务ID
*/
TaskId: number;
/**
* 任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
Name?: string;
/**
* 任务描述，最大长度为1024个字符
*/
Description?: string;
/**
* 任务开关，0 关闭，1 启用
*/
Enable?: number;
/**
* 数据源ID
*/
DataSourceId?: string;
/**
* 用于传入的数据源的条件，目前只支持数据库，所以目前表示数据库的名称，最多添加5个数据库，之间通过逗号分隔
*/
Condition?: string;
/**
* 通用规则集开关；0 关闭，1 启用
*/
GeneralRuleSetEnable?: number;
/**
* 合规组ID列表，最多支持添加5个
*/
ComplianceGroupIds?: Array<number | bigint>;
/**
* 执行计划； 0立即 1定时，选择“立即”时，扫描周期只能选择单次
*/
Plan?: number;
/**
* 扫描周期；0单次 1每天 2每周 3每月
*/
Period?: number;
/**
* 任务定时启动时间，格式：2006-01-02 15:04:05
当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。
*/
TimingStartTime?: string;
/**
* 资源所在地域
*/
ResourceRegion?: string;
/**
* 数据源类型，可取值如下：
cdb 表示云数据库 MySQL,
dcdb 表示TDSQL MySQL版,
mariadb 表示云数据库 MariaDB,
postgres 表示云数据库 PostgreSQL,
cynosdbpg 表示TDSQL-C PostgreSQL版,
cynosdbmysql 表示TDSQL-C MySQL版,
selfbuilt-db 表示自建数据库
*/
DataSourceType?: string;
}
/**
* DeleteDSPAAssessmentTask返回参数结构体
*/
export interface DeleteDSPAAssessmentTaskResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 合规组中规则信息，用于合规组列表中规则信息展示
*/
export interface DspaDiscoveryComplianceGroupRuleInfo {
/**
* 敏感数据识别规则ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId: number;
/**
* 敏感数据识别规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName: string;
/**
* 敏感数据分类ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryId: number;
/**
* 敏感数据分级ID, 目前只支持高、中、低三级
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelId: number;
}
/**
* CreateDSPASelfBuildMetaResource请求参数结构体
*/
export interface CreateDSPASelfBuildMetaResourceRequest {
/**
* Dspa实例ID。
*/
DspaId: string;
/**
* 自建数据库类型。目前支持的自建数据库类型按照协议进行区分，支持两种开源数据库协议：
mysql_like_proto -- Mysql协议类关系型数据库，
postgre_like_proto -- Postgre协议类关系型数据库。
其他闭源协议的数据库如SqlServer、Oracle等暂不支持。
*/
MetaType: string;
/**
* 资源所处地域。
*/
ResourceRegion: string;
/**
* 自建云资源ID。
*/
ResourceId: string;
/**
* 可用于访问自建云资源的IP。
*/
ResourceVip: string;
/**
* 可用于访问自建云资源的端口。
*/
ResourceVPort: number;
/**
* 自建云资源的VPC ID。
*/
ResourceUniqueVpcId: string;
/**
* 自建云资源的Subnet ID。
*/
ResourceUniqueSubnetId: string;
/**
* 自建云资源所处的服务类型，可选：
cvm - 通过云服务器直接访问。
clb - 通过LB的方式进行访问。
*/
ResourceAccessType: string;
/**
* 账户名。
*/
UserName: string;
/**
* 账户密码。
*/
Password: string;
/**
* 资源名称，1-60个字符。
*/
ResourceName?: string;
}
/**
* ModifyDSPACategoryRelation请求参数结构体
*/
export interface ModifyDSPACategoryRelationRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 当前分类id
*/
CategoryId: number;
/**
* 合并到的分类id
*/
MergedCategoryId: number;
/**
* 合规组模板id
*/
ComplianceId: number;
}
/**
* DescribeDSPAAssessmentRiskOverview返回参数结构体
*/
export interface DescribeDSPAAssessmentRiskOverviewResponse {
/**
* 风险总数
*/
TotalCount: number;
/**
* 高危风险数
*/
HighRiskCount: number;
/**
* 周同比
*/
HighRiskWeekRatio: number;
/**
* 高危风险数日环比
*/
HighRiskDayRatio: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 扫描任务结果详情
*/
export interface DspaDiscoveryTaskResultDetail {
/**
* 任务ID
*/
TaskId: number;
/**
* 扫描结果详情ID
*/
FieldResultId: number;
/**
* 所属数据表名
*/
TableName: string;
/**
* 字段名
*/
FieldName: string;
/**
* 敏感数据分类ID
*/
CategoryId: number;
/**
* 敏感数据分类名称
*/
CategoryName: string;
/**
* 敏感数据分级ID
*/
LevelId: number;
/**
* 敏感数据分级名称
*/
LevelName: string;
/**
* 规则名称
*/
RuleName: string;
/**
* 规则ID
*/
RuleId: number;
/**
* 敏感数据分级分数
*/
LevelRiskScore: number;
/**
* 保护措施
注意：此字段可能返回 null，表示取不到有效值。
*/
SafeGuard: DspaSafeGuard;
/**
* 分类路径
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryFullPath: string;
}
/**
* DescribeLeafClassification请求参数结构体
*/
export declare type DescribeLeafClassificationRequest = null;
/**
* CreateClassificationRule请求参数结构体
*/
export declare type CreateClassificationRuleRequest = null;
/**
* DescribeDSPAAssessmentTemplates请求参数结构体
*/
export interface DescribeDSPAAssessmentTemplatesRequest {
/**
* DSPA实例Id，格式“dspa-xxxxxxxx”
*/
DspaId: string;
/**
* 偏移量。默认为0
*/
Offset?: number;
/**
* 结果集个数限制。默认为20，最大值为100
*/
Limit?: number;
/**
* 过滤项。
支持模糊搜索：（TemplateId，TemplateName）
支持过滤：
Source：模版来源，system / user
UseType：模版类型，auto，semi-auto，law等
Status：模版启用状态，draft / launched
*/
Filters?: Array<DspaAssessmentFilter>;
}
/**
* 高风险资产详情信息
*/
export interface HighRiskAssetsDetail {
/**
* 实例id
注意：此字段可能返回 null，表示取不到有效值。
*/
InstanceId?: string;
/**
* 数据源类型
注意：此字段可能返回 null，表示取不到有效值。
*/
DataSourceType?: string;
/**
* 数据源名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DataSourceName?: string;
/**
* 资产对象名称
注意：此字段可能返回 null，表示取不到有效值。
*/
AssetsName?: string;
/**
* 高风险个数
注意：此字段可能返回 null，表示取不到有效值。
*/
HighRiskCount?: number;
/**
* 风险类型
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskType?: string;
/**
* 总的风险个数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalRiskCount?: number;
/**
* 风险面
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskSide?: string;
/**
* 地域
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceRegion?: string;
}
/**
* 分类分级扫描结果字段的保护措施
*/
export interface DspaSafeGuard {
/**
* 加密状态，可取值如下：
UNSET 未设置
DISABLE 规则设置未启用
ENABLE 规则设置并启用
注意：此字段可能返回 null，表示取不到有效值。
*/
Encrypt: string;
/**
* 脱敏状态，可取值如下：
UNSET 未设置
DISABLE 规则设置未启用
ENABLE 规则设置并启用
注意：此字段可能返回 null，表示取不到有效值。
*/
Desensitization: string;
}
/**
* 某个分级单个信息
*/
export interface ItemLevel {
/**
* 分级标识名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
LevelRiskName: string;
/**
* 分级标识对应的风险分数值，1-10，最小为1，最大为10
*/
LevelRiskScore: number;
}
/**
* 敏感数据识别规则扩展参数
*/
export interface DatagovRuleExtendParameter {
/**
* 扩展参数名称，目前支持如下两个扩展属性名称：
IsFullWordMatch，表示是否全文匹配，该Name对应的Value可取值为"true"或"false":，默认值为"false"，
IsIgnoreCase，表示是否忽略大小写，该Name对应的Value可取值为"true"或"false"，默认值为"true"
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 扩展参数值
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* ModifyDSPAClusterInfo返回参数结构体
*/
export interface ModifyDSPAClusterInfoResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DSPA敏感数据扫描数据源条件
*/
export interface DiscoveryCondition {
/**
* RDB实例列表
注意：此字段可能返回 null，表示取不到有效值。
*/
RDBInstances?: Array<RDBInstance>;
/**
* COS实例列表
注意：此字段可能返回 null，表示取不到有效值。
*/
COSInstances?: Array<COSInstance>;
/**
* Mongo实例列表
注意：此字段可能返回 null，表示取不到有效值。
*/
NOSQLInstances?: Array<NOSQLInstance>;
/**
* ES实例列表
注意：此字段可能返回 null，表示取不到有效值。
*/
ESInstances?: Array<ESInstance>;
}
/**
* ModifyStandardInfo返回参数结构体
*/
export interface ModifyStandardInfoResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDSPAAssessmentRiskTemplateDetail请求参数结构体
*/
export interface DescribeDSPAAssessmentRiskTemplateDetailRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 模板id
*/
TemplateId: number;
/**
* 限制条数
*/
Limit: number;
/**
* 偏移量
*/
Offset: number;
}
/**
* DescribeDSPADiscoveryTaskResultDetail返回参数结构体
*/
export interface DescribeDSPADiscoveryTaskResultDetailResponse {
/**
* 扫描结果详情列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Items?: Array<DspaDiscoveryTaskResultDetail>;
/**
* 符合条件的扫描结果详情记录数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDSPACategoryRelation返回参数结构体
*/
export interface ModifyDSPACategoryRelationResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 风险级别详情的矩阵
*/
export interface RiskLevelMatrix {
/**
* 存储id
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: number;
/**
* 分类分级levelID
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveLevelId?: number;
/**
* 分类分级名称
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveLevelName?: string;
/**
* 漏洞级别
注意：此字段可能返回 null，表示取不到有效值。
*/
VulnerabilityLevel?: string;
/**
* 风险级别
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskLevel?: string;
}
/**
* 扫描任务选择的合规组信息
*/
export interface ScanTaskComplianceInfo {
/**
* 合规组ID
*/
ComplianceGroupId: number;
/**
* 合规组名称
*/
ComplianceGroupName: string;
}
/**
* DescribeDSPAAssessmentRiskDistributionOverview返回参数结构体
*/
export interface DescribeDSPAAssessmentRiskDistributionOverviewResponse {
/**
* 风险类型分布
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskTypeDistribution?: Array<Note>;
/**
* 风险详情分布
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskDetailDistribution?: Array<Note>;
/**
* 风险资产详情
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskAssetsDistribution?: Array<Note>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* COS资源的桶信息
*/
export interface CosResourceItem {
/**
* cos数据源ID。
*/
ResourceId: string;
/**
* 桶所在地域。
*/
ResourceRegion: string;
/**
* 桶名称。
*/
ResourceName: string;
}
/**
* CreateDSPACOSDiscoveryTask请求参数结构体
*/
export interface CreateDSPACOSDiscoveryTaskRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
Name: string;
/**
* 数据源ID
*/
DataSourceId: string;
/**
* 任务开关，0 关闭，1 启用
*/
Enable: number;
/**
* 桶名
*/
Bucket: string;
/**
* 通用规则集开关，0 关闭，1 启用
*/
GeneralRuleSetEnable: number;
/**
* 执行计划， 0立即 1定时，选择“立即”时，扫描周期只能选择单次。
*/
Plan: number;
/**
* 扫描周期，0单次 1每天 2每周 3每月
*/
Period: number;
/**
* 待扫描文件类型，用逗号隔开，格式如：[".txt", ".csv", ".log", ".xml",".html", ".json"]。
*/
FileTypes: Array<string>;
/**
* 文件大小上限，单位为KB，如1000, 目前单个文件最大只支持100MB（102400KB）
*/
FileSizeLimit: number;
/**
* 资源所在地域
*/
ResourceRegion: string;
/**
* 任务描述，最大长度为1024个字符
*/
Description?: string;
/**
* 合规组ID列表，最多支持添加5个
*/
ComplianceGroupIds?: Array<number | bigint>;
/**
* 任务定时启动时间，格式如：2006-01-02 15:04:05
当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。
*/
TimingStartTime?: string;
}
/**
* COS敏感数据识别规则
*/
export interface DspaDiscoveryCOSDataRule {
/**
* 只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一.
默认值为or
注意：此字段可能返回 null，表示取不到有效值。
*/
Operator?: string;
/**
* 规则内容
注意：此字段可能返回 null，表示取不到有效值。
*/
Contents?: Array<DspaDiscoveryDataContent>;
}
/**
* DescribeDSPAAssessmentNewDiscoveredRiskOverview请求参数结构体
*/
export interface DescribeDSPAAssessmentNewDiscoveredRiskOverviewRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 评估模板id
*/
TemplateId: number;
}
/**
* 扫描规则内容
*/
export interface DspaDiscoveryDataContent {
/**
* 规则内容，可以是正则规则，关键词，
忽略词扥
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleContent?: string;
/**
* 是否区分大小写
false: 不区分大小写
true:区分大小写
注意：此字段可能返回 null，表示取不到有效值。
*/
IsIgnoreCase?: boolean;
}
/**
* DescribeDSPACOSDataAssetBuckets请求参数结构体
*/
export interface DescribeDSPACOSDataAssetBucketsRequest {
/**
* DSPA实例Id
*/
DspaId: string;
/**
* 合规组Id
*/
ComplianceId: number;
}
/**
* RestartDSPAAssessmentTask请求参数结构体
*/
export interface RestartDSPAAssessmentTaskRequest {
/**
* DSPA实例Id，格式“dspa-xxxxxxxx”
*/
DspaId: string;
/**
* 评估任务Id，格式“task-xxxxxxxx”
*/
TaskId: string;
}
/**
* VerifyDSPACOSRule请求参数结构体
*/
export interface VerifyDSPACOSRuleRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 待验证COS规则
*/
COSRules: ScanTaskCOSRules;
/**
* 待验证数据
*/
Data: string;
}
/**
* DescribeReportTasks请求参数结构体
*/
export interface DescribeReportTasksRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 分页大小
*/
Limit: number;
/**
* 分页偏移量
*/
Offset: number;
/**
* 报表名称
*/
ReportName?: string;
}
/**
* CreateDSPADiscoveryRule请求参数结构体
*/
export interface CreateDSPADiscoveryRuleRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 规则名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
Name: string;
/**
* 规则描述，最大长度为1024个字符
*/
Description?: string;
/**
* RDB类敏感数据识别规则
*/
RDBRules?: DspaDiscoveryRDBRules;
/**
* COS类敏感数据识别规则
*/
COSRules?: DspaDiscoveryCOSRules;
}
/**
* AuthorizeDSPAMetaResources返回参数结构体
*/
export interface AuthorizeDSPAMetaResourcesResponse {
/**
* DSPA实例ID。
*/
DspaId: string;
/**
* 授权结果。
注意：此字段可能返回 null，表示取不到有效值。
*/
Results: Array<DspaTaskResult>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 敏感数据扫描任务识别规则详情
*/
export interface DspaDiscoveryRuleDetail {
/**
* 规则ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId: number;
/**
* 规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name: string;
/**
* 规则描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description: string;
/**
* 规则来源，取值：0 内置, 1 自定义
注意：此字段可能返回 null，表示取不到有效值。
*/
Source: number;
/**
* RDB规则详情
注意：此字段可能返回 null，表示取不到有效值。
*/
RDBRules: DspaDiscoveryRDBRules;
/**
* COS规则详情
注意：此字段可能返回 null，表示取不到有效值。
*/
COSRules: DspaDiscoveryCOSRules;
}
/**
* ModifyDSPACategory请求参数结构体
*/
export interface ModifyDSPACategoryRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 数据分类ID
*/
CategoryId: number;
/**
* 敏感数据分类名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
Name: string;
}
/**
* COS对象存储数据资产详情
*/
export interface DspaCOSDataAssetDetail {
/**
* 对象桶
*/
BucketName: string;
/**
* 对象名称
*/
FileName: string;
/**
* 规则名称
*/
RuleName: string;
/**
* 出现次数
*/
SensitiveDataCount: number;
/**
* 敏感数据分类
*/
CategoryName: string;
/**
* 敏感等级
*/
LevelRiskName: string;
/**
* KMS加密
*/
KMSEncrypted: boolean;
/**
* 文件类型
*/
FileType: string;
/**
* 文件大小
*/
FileSize: string;
/**
* 敏感数据分级分数
*/
LevelRiskScore: number;
/**
* 数据源ID
*/
DataSourceId: string;
/**
* 规则id
*/
RuleId: number;
/**
* 资源所在地域
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceRegion: string;
/**
* 分类ID
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryId: number;
/**
* 分级ID
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelId: number;
/**
* 文件扫描结果ID
注意：此字段可能返回 null，表示取不到有效值。
*/
FileResultId: number;
/**
* 数据源名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DataSourceName: string;
/**
* 分类路径
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryFullPath: string;
}
/**
* 数据库信息
*/
export interface DBStatements {
/**
* 数据库名称
*/
DBName: string;
/**
* 数据库Schema
*/
DBSchema: string;
}
/**
* DescribeDSPAAssessmentRiskLevelList返回参数结构体
*/
export interface DescribeDSPAAssessmentRiskLevelListResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 风险等级列表
注意：此字段可能返回 null，表示取不到有效值。
*/
RiskLevelList?: Array<RiskLevelRisk>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDSPADiscoveryTask请求参数结构体
*/
export interface CreateDSPADiscoveryTaskRequest {
/**
* DSPA实例ID
*/
DspaId: string;
/**
* 任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复
*/
Name: string;
/**
* 数据源ID
*/
DataSourceId: string;
/**
* 任务开关，0 关闭，1 启用
*/
Enable: number;
/**
* 通用规则集开关，0 关闭，1 启用
*/
GeneralRuleSetEnable: number;
/**
* 执行计划， 0立即 1定时，选择“立即”时，扫描周期只能选择单次
*/
Plan: number;
/**
* 扫描周期，0单次 1每天 2每周 3每月
*/
Period: number;
/**
* 资源所在地域
*/
ResourceRegion: string;
/**
* 数据源类型，可取值如下：
cdb 表示云数据库 MySQL,
dcdb 表示TDSQL MySQL版,
mariadb 表示云数据库 MariaDB,
postgres 表示云数据库 PostgreSQL,
cynosdbpg 表示TDSQL-C PostgreSQL版,
cynosdbmysql 表示TDSQL-C MySQL版,
selfbuilt-db 表示自建数据库
*/
DataSourceType: string;
/**
* 任务描述，最大长度为1024个字符
*/
Description?: string;
/**
* 用于传入的数据源的条件，目前只支持数据库，所以目前表示数据库的名称，选择多个数据库，之间通过逗号分隔，若不选，则默认选择全部数据库
*/
Condition?: string;
/**
* 合规组ID列表，最多支持添加5个
*/
ComplianceGroupIds?: Array<number | bigint>;
/**
* 任务定时启动时间，格式如：2006-01-02 15:04:05
当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。
*/
TimingStartTime?: string;
}
/**
* 权限风险详情
*/
export interface PrivilegeRisk {
/**
* 账户名
注意：此字段可能返回 null，表示取不到有效值。
*/
AccountName?: Array<string>;
/**
* 表名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TableName?: string;
/**
* 说明
注意：此字段可能返回 null，表示取不到有效值。
*/
Description?: string;
}
/**
* COS对象存储敏感数据资产统计
*/
export interface DspaCOSDataAssetCount {
/**
* 数组资产类型，0代表关系型数据库资产，1代表对象存储COS资产
注意：此字段可能返回 null，表示取不到有效值。
*/
DataAssetType: number;
/**
* 已扫描的存储桶的个数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalBucketCnt: number;
/**
* 对象总数
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalObjectCnt: number;
/**
* 敏感数据类型个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveCategoryCnt: number;
/**
* 敏感数据条数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveDataCnt: number;
/**
* 敏感等级分布
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveLevel: Array<SensitiveLevel>;
/**
* 敏感存储桶个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveBucketCnt: number;
/**
* 敏感对象个数
注意：此字段可能返回 null，表示取不到有效值。
*/
SensitiveObjectCnt: number;
/**
* 数据分类分布
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryDistributed: Array<DspaDataCategoryDistributed>;
}
/**
* ES扫描任务结果详情
*/
export interface ESTaskResultDetail {
/**
* id
注意：此字段可能返回 null，表示取不到有效值。
*/
Id?: number;
/**
* 任务id
注意：此字段可能返回 null，表示取不到有效值。
*/
TaskId?: number;
/**
* 字段名称
注意：此字段可能返回 null，表示取不到有效值。
*/
FieldName?: string;
/**
* 规则id
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleId?: number;
/**
* 规则名称
注意：此字段可能返回 null，表示取不到有效值。
*/
RuleName?: string;
/**
* 分类id
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryId?: number;
/**
* 分类名称
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryName?: string;
/**
* 多级分类的路径
注意：此字段可能返回 null，表示取不到有效值。
*/
CategoryArr?: Array<string>;
/**
* 分级id
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelId?: number;
/**
* 分级名称
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelName?: string;
/**
* 分级分数
注意：此字段可能返回 null，表示取不到有效值。
*/
LevelRiskScore?: number;
}
/**
* 云上资源元数据
*/
export interface DspaCloudResourceMeta {
/**
* 用户资源ID。
*/
ResourceId: string;
/**
* 资源名称。
*/
ResourceName: string;
/**
* 资源VIP。
*/
ResourceVip: string;
/**
* 资源端口。
*/
ResourceVPort: number;
/**
* 资源被创建时间。
*/
ResourceCreateTime: string;
/**
* 用户资源VPC ID 字符串。
*/
ResourceUniqueVpcId: string;
/**
* 用户资源Subnet ID 字符串。
*/
ResourceUniqueSubnetId: string;
}
/**
* DescribeESAssetSensitiveDistribution请求参数结构体
*/
export interface DescribeESAssetSensitiveDistributionRequest {
/**
* dspa实例id
*/
DspaId: string;
/**
* 合规组id
*/
ComplianceId: number;
/**
* 查询的资产信息列表
*/
AssetList: Array<AssetList>;
}
/**
*