tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,329 lines (2,171 loc) • 175 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** AKSK泄漏信息 */
declare interface AKSKLeak {
/** AK编码 */
AK?: string;
/** SK编码 */
SK?: string;
/** URL编码 */
URL?: string;
}
/** 账户风险 */
declare interface AccountRisk {
/** id(可不参考) */
Id?: string;
/** 风险账户 */
RiskAccount?: string;
}
/** DSPA评估控制项 */
declare interface AssessmentControlItem {
/** 评估项Id */
ItemId?: string;
/** 评估项名称 */
ItemName?: string;
/** 评估项描述 */
Description?: string;
/** 评估项来源,内置/用户自定,取值(system,user) */
Source?: string;
/** 评估项类型,问卷/自动化,取值(questionnaire,auto) */
ItemType?: string;
/** 评估项子类型,单选/多选/时间/文本/AKSK等,取值(singlechoice,multichoice,date,text,AKSK……等) */
ItemSubType?: string;
/** 评估项创建时间 */
CreatedTime?: string;
/** 评估项启用状态,启用/未启用,取值draft / launched */
Status?: string;
/** 评估项关联的模板数量 */
TemplateCount?: number;
}
/** DSPA评估风险项 */
declare interface AssessmentRisk {
/** 风险项Id */
RiskId?: string;
/** 风险项描述 */
RiskDescription?: string;
/** 评估模板Id */
TemplateId?: string;
/** 评估模板名称 */
TemplateName?: string;
/** 评估项Id */
ControlItemId?: string;
/** 评估项名称 */
ControlItemName?: string;
/** 评估描述 */
ControlItemDesc?: string;
/** 风险等级,取值(high,medium,low) */
RiskLevel?: string;
/** 风险缓解措施 */
RiskMitigation?: string;
/** 风险处理状态。(waiting待处理, processing处理中, finished已处理) */
Status?: string;
/** 风险生成时间 */
CreatedTime?: string;
/** 风险负责人 */
RiskOwner?: string;
/** 风险涉及资产 */
RelatedAsset?: string;
/** 风险涉及资产id */
DataSourceId?: string;
/** 风险涉及资产名称 */
DataSourceName?: string;
/** 资产名称 */
AssetName?: string;
/** 建议使用安全产品 */
SecurityProduct?: SecurityProduct[];
/** 风险类型 */
RiskType?: string;
/** 风险面 */
RiskSide?: string;
/** 数据源类型 */
DataSourceType?: string;
}
/** 风险项列表详细数据 */
declare interface AssessmentRiskItem {
/** 脆弱项id */
Id?: number;
/** 名称 */
RiskName?: string;
/** 脆弱性级别 */
Level?: string;
/** 说明 */
Description?: string;
/** 风险类型 */
RiskType?: string;
/** 关联模板个数 */
ReferTemplateCount?: number;
/** 支持的数据源 */
SupportDataSource?: string[];
/** 风险面 */
RiskSide?: string;
/** 关联模板列表 */
ReferTemplateList?: TemplateInfo[];
}
/** DSPA评估任务 */
declare interface AssessmentTask {
/** 评估任务Id */
TaskId: string;
/** 评估任务的自增ID */
TaskUid: number;
/** 评估任务名称 */
TaskName: string;
/** 业务名称 */
BusinessName: string;
/** 业务所属部门 */
BusinessDept: string;
/** 业务负责人 */
BusinessOwner: string;
/** 评估模板Id */
TemplateId: string;
/** 评估模板名称 */
TemplateName: string;
/** 分类分级模板Id */
ComplianceGroupId: number;
/** 分类分级模板名称 */
ComplianceGroupName: string;
/** 评估项数量 */
ControlItemCount: number;
/** 风险项数量(仅状态为finished的风险项不计入总数,其余状态均算入该数量) */
RiskCount: number;
/** 评估任务完成时间 */
FinishedTime: string;
/** 评估任务发起时间 */
CreatedTime: string;
/** 评估状态。(waiting待评估,processing评估中, , finished已评估, failed评估失败) */
Status: string;
/** 待处理各等级风险项信息 */
RiskCountInfoList: RiskCountInfo[];
/** 数据源信息 */
DiscoveryCondition: DiscoveryCondition;
/** 评估任务失败信息 */
ErrorInfo: string;
/** 模板主键id */
TemplateUid: number;
/** 进度百分比 */
ProgressPercent: number;
}
/** DSPA评估模板 */
declare interface AssessmentTemplate {
/** id */
Id?: number;
/** 评估模板Id */
TemplateId?: string;
/** 评估模板名称 */
TemplateName?: string;
/** 描述信息 */
Description?: string;
/** 模板来源,内置/用户自定,取值(system,user) */
Source?: string;
/** 模板类型,自动化/半自动化/问卷,取值(auto,semi-auto,law)等 */
UseType?: string;
/** 评估模板创建时间 */
CreatedTime?: string;
/** 模板关联的评估项数量 */
ControlItemCount?: number;
/** 模板已启用的评估项数量 */
AppliedItemCount?: number;
/** 模板启用状态,草稿/已启用,取值draft / launched */
Status?: string;
/** 支持的数据源类型 */
SupportDataSource?: string[];
/** 是否包含攻击面风险 */
IsASMTemplate?: boolean;
/** 合规组id */
IdentifyComplianceId?: number;
}
/** 数据资产报告-cos的资产详情 */
declare interface AssetCosDetail {
/** 桶的名 */
Bucket?: string;
/** 数据源类型 */
DataType?: string;
/** 文件的个数 */
FileNums?: number;
/** 敏感的文件个数 */
SensitiveFileNums?: number;
/** 敏感分布 */
DistributionData?: Note[];
/** cos文件的敏感数据个数 */
MatchedNum?: number;
}
/** RDB敏感资产详情列表 */
declare interface AssetDBDetail {
/** 数据源id */
DataSourceId?: string;
/** 数据库名称 */
DdName?: string;
/** 数据库类型 */
DataType?: string;
/** 表的数量 */
TableNums?: number;
/** 敏感表数量 */
SensitiveTableNums?: number;
/** 字段的数量 */
FieldNums?: number;
/** 敏感字段的数量 */
SensitiveFieldNums?: number;
/** 敏感数据分布 */
DistributionData?: Note[];
}
/** 数据资产报告页面-用户查询入参 */
declare interface AssetList {
/** 数据源类型 */
DataSourceType: string;
/** 数据源信息 */
DataSourceInfo: DataSourceInfo[];
}
/** COS敏感数据识别规则 */
declare interface COSDataRule {
/** 只能取and 、or两个值其中之一,and:字段和内容同时满足,or:字段和内容满足其一.默认值为or */
Operator?: string;
/** 规则内容 */
Contents?: DataContent[];
}
/** COS数据源实例信息 */
declare interface COSInstance {
/** 数据源Id */
DataSourceId: string;
/** 桶名 */
BucketName: string;
/** 资源所在地域 */
ResourceRegion: string;
}
/** 分类规则信息 */
declare interface CategoryRule {
/** 分类id */
CategoryId?: number;
/** 规则id */
RuleId?: number;
/** 规则名称 */
RuleName?: string;
/** 级别id */
LevelId?: number;
/** 级别名称 */
LevelName?: string;
/** 分类规则绑定关系id */
Id?: number;
/** 别名ID */
AliasRuleId?: number;
/** 别名规则名称 */
AliasRuleName?: string;
/** 各类分类分级规则数量 */
RuleEffectItems?: RuleEffectItem[];
/** 规则状态 */
RuleStatus?: number;
}
/** 分类规则统计信息 */
declare interface CategoryRuleStatistic {
/** 分类id */
CategoryId?: number;
/** 规则数量 */
RuleCount?: number;
/** 分类名称 */
CategoryName?: string;
}
/** 云数据库资源项 */
declare interface CloudResourceItem {
/** 资源所处地域。 */
Region: string;
/** 云上资源列表。 */
Items: DspaCloudResourceMeta[];
}
/** 模板详情 */
declare interface ComplianceGroupDetail {
/** 模板id */
Id?: number;
/** 模板名称 */
Name?: string;
/** 描述 */
Description?: string;
/** 模板类型 */
ComplianceGroupType?: number;
/** 模板分级方案id */
LevelGroupId?: number;
/** 模板分级方案名称 */
LevelGroupName?: string;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
ModifyTime?: string;
/** 是否开启别名 */
IsAlias?: boolean;
}
/** 合规组中规则信息:包括规则ID,数据分类ID, 数据分级标识ID */
declare interface ComplianceGroupRuleIdInfo {
/** 敏感数据识别规则ID */
RuleId: number;
/** 敏感数据分类ID */
CategoryId: number;
/** 敏感数据分级标识ID, 系统支持高、中、低三级,也支持自定义分级 */
LevelId: number;
}
/** 数据资产报告-cos的敏感资产报告详情 */
declare interface CosAsset {
/** 桶的个数 */
BucketNums?: number;
/** 敏感桶的个数 */
SensitiveBucketNums?: number;
/** 文件个数 */
FileNums?: number;
/** 敏感文件的个数 */
SensitiveFileNums?: number;
}
/** cos桶资源项 */
declare interface CosBucketItem {
/** 资源所处地域。 */
Region: string;
/** COS桶列表。 */
Buckets: string[];
}
/** COS资源的桶信息 */
declare interface CosResourceItem {
/** cos数据源ID。 */
ResourceId: string;
/** 桶所在地域。 */
ResourceRegion: string;
/** 桶名称。 */
ResourceName: string;
}
/** cos批量操作返回结果结构体 */
declare interface CosTaskResult {
/** 结果类型。 */
Result?: string;
/** 结果描述。 */
ResultDescription?: string;
/** 错误信息描述。 */
ErrDescription?: ErrDescription;
/** 资源ID。 */
ResourceId?: string;
}
/** 合规组分类关联规则信息 */
declare interface CreateComplianceRules {
/** 规则id */
RuleId: number;
/** 级别id */
LevelId: number;
}
/** 绑定的实例信息 */
declare interface DBInstanceInfo {
/** 数据源id */
ResourceId?: string;
/** 数据源绑定的db信息 */
DbInfos?: DbInfo[];
}
/** 数据库信息 */
declare interface DBStatements {
/** 数据库名称 */
DBName: string;
/** 数据库Schema */
DBSchema: string;
}
/** COS元数据信息 */
declare 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;
/** 治理授权状态,0:关闭 1:开启 */
GovernAuthStatus?: number;
}
/** DSPA数据源的数据库信息 */
declare interface DSPADataSourceDbInfo {
/** 数据库名称 */
DbName?: string;
}
/** 元数据类型 */
declare interface DSPAMetaType {
/** 元数据类型 */
MetaType?: string;
/** 支持的此元数据类型的地域列表 */
Regions?: string[];
/** 此元数据类型支持的授权类型:account -- 账户名密码授权,账户的最高只读权限需要由用户自行赋予;automatic -- 一键授权,由DSPA自动生成账户名密码并自动在实例中给账户名赋予最高只读权限;如果此列表为空,表明此类资源不支持以上的授权机制,无法通过后台进行授权。 */
SupportedAuthTypes?: string[];
}
/** DSPA分类分级任务扫描的表信息 */
declare interface DSPATableInfo {
/** 表名 */
TableName?: string;
}
/** 敏感数据分类 */
declare interface DataCategory {
/** 分类ID */
CategoryId: number;
/** 敏感数据分类名称 */
Name: string;
/** 敏感数据分类来源,取值:0 内置, 1 自定义 */
Source: number;
/** 关联模板数量 */
RelateComplianceCount: number;
}
/** 扫描规则内容 */
declare interface DataContent {
/** 规则内容,可以是正则规则,关键词,忽略词扥 */
RuleContent: string;
/** 是否区分大小写false: 不区分大小写true:区分大小写 */
IsIgnoreCase?: boolean;
}
/** 敏感数据识别规则 */
declare interface DataRule {
/** 规则类型;取值:keyword 关键字, regex 正则 */
RuleType: string;
/** 内容 */
RuleContent: string;
/** 该字段是针对规则类型RuleType为keyword类型时的一个扩展属性 */
ExtendParameters?: DatagovRuleExtendParameter[];
}
/** 敏感数据识别规则集 */
declare interface DataRules {
/** 操作符;只能取and, or的其中一种 */
Operator: string;
/** 规则 */
Contents: DataRule[];
}
/** dsgc-资产梳理报表-数据源信息 */
declare interface DataSourceInfo {
/** 数据源ID */
DataSourceId: string;
/** 针对rbd-就是绑定的db_name */
BindList?: string[];
}
/** 敏感数据识别规则扩展参数 */
declare interface DatagovRuleExtendParameter {
/** 扩展参数名称,目前支持如下两个扩展属性名称:IsFullWordMatch,表示是否全文匹配,该Name对应的Value可取值为"true"或"false":,默认值为"false",IsIgnoreCase,表示是否忽略大小写,该Name对应的Value可取值为"true"或"false",默认值为"true" */
Name?: string;
/** 扩展参数值 */
Value?: string;
}
/** 查询绑定的db信息 */
declare interface DbInfo {
/** 数据库名称 */
DbName?: string;
/** 绑定的状态 */
ValidStatus?: string;
/** 绑定的类型 */
BindType?: string;
}
/** 数据库实例的DB绑定关系状态信息。 */
declare interface DbRelationStatusItem {
/** DB名称。 */
DbName?: string;
/** DB绑定状态。 */
BindStatus?: string;
/** DB有效性状态。 */
ValidStatus?: string;
}
/** 数据库DB资源项 */
declare interface DbResourceItem {
/** DB名称。 */
DbName: string;
}
/** database批量操作返回结果结构体 */
declare interface DbTaskResult {
/** 结果类型。 */
Result?: string;
/** 结果描述。 */
ResultDescription?: string;
/** 错误信息描述。 */
ErrDescription?: ErrDescription;
/** 资源ID。 */
ResourceId?: string;
/** database名称。 */
DbName?: string;
}
/** DSPA敏感数据扫描数据源条件 */
declare interface DiscoveryCondition {
/** RDB实例列表 */
RDBInstances?: RDBInstance[];
/** COS实例列表 */
COSInstances?: COSInstance[];
/** Mongo实例列表 */
NOSQLInstances?: NOSQLInstance[];
/** ES实例列表 */
ESInstances?: ESInstance[];
}
/** 描述键值对过滤器,用于条件过滤查询 */
declare interface DspaAssessmentFilter {
/** 过滤类型。 */
Name: string;
/** 过滤类型的值。 */
Values: string[];
}
/** COS对象存储敏感数据资产统计 */
declare interface DspaCOSDataAssetCount {
/** 数组资产类型,0代表关系型数据库资产,1代表对象存储COS资产 */
DataAssetType?: number;
/** 已扫描的存储桶的个数 */
TotalBucketCnt?: number;
/** 对象总数 */
TotalObjectCnt?: number;
/** 敏感数据类型个数 */
SensitiveCategoryCnt?: number;
/** 敏感数据条数 */
SensitiveDataCnt?: number;
/** 敏感等级分布 */
SensitiveLevel?: SensitiveLevel[];
/** 敏感存储桶个数 */
SensitiveBucketCnt?: number;
/** 敏感对象个数 */
SensitiveObjectCnt?: number;
/** 数据分类分布 */
CategoryDistributed?: DspaDataCategoryDistributed[];
}
/** COS对象存储数据资产详情 */
declare 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;
/** 资源所在地域 */
ResourceRegion?: string;
/** 分类ID */
CategoryId?: number;
/** 分级ID */
LevelId?: number;
/** 文件扫描结果ID */
FileResultId?: number;
/** 数据源名称 */
DataSourceName?: string;
/** 分类路径 */
CategoryFullPath?: string;
/** 0-系统识别1-人工识别 */
IdentifyType?: number;
/** 0-系统识别1-人工识别 */
CheckStatus?: number;
}
/** COS敏感数据扫描任务相关信息 */
declare 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;
/** 任务最新的一次执行结果信息,该字段用于查询任务列表接口 */
Result?: ScanTaskResult;
/** 定时开始时间 */
TimingStartTime?: string;
/** 关联分类模板是否更新 */
ComplianceUpdate?: boolean;
}
/** 扫描任务元数据信息 */
declare interface DspaCOSDiscoveryTaskDataSourceInfo {
/** 数据源ID */
DataSourceId?: string;
/** 代理地址 */
ProxyAddress?: string[];
/** 数据源名称 */
DataSourceName?: string;
/** 扫描任务条件 */
Condition?: DspaDiscoveryTaskCOSCondition;
/** 资源所在地域 */
ResourceRegion?: string;
}
/** COS敏感数据扫描任务相关信息 */
declare interface DspaCOSDiscoveryTaskDetail {
/** 任务名称 */
Name?: string;
/** 任务描述 */
Description?: string;
/** 执行周期,0单次 1每天 2每周 3每月 */
Period?: number;
/** 执行计划,0立即 1定时 */
Plan?: number;
/** 任务开关;1 打开,0 关闭 */
Enable?: number;
/** 数据源对象信息 */
DataSourceInfo?: DspaCOSDiscoveryTaskDataSourceInfo;
/** 通用规则集开关,0 关闭,1 启用 */
GeneralRuleSetEnable?: number;
/** 当创建任务时,用户打开了通用规则集开关,则该字段就会保存默认合规组信息 */
DefaultComplianceInfo?: ScanTaskComplianceInfo[];
/** 该任务中用户选择的合规组信息列表 */
CustomComplianceInfo?: ScanTaskComplianceInfo[];
/** 定时开始时间 */
TimingStartTime?: string;
}
/** COS扫描任务结果,按照数据库级别展示 */
declare interface DspaCOSDiscoveryTaskResult {
/** 扫描bucket结果ID */
BucketResultId?: number;
/** 任务ID */
TaskId?: number;
/** 任务名称 */
TaskName?: string;
/** 扫描任务最新一次扫描结果ID */
ResultId?: number;
/** 数据源ID */
DataSourceId?: string;
/** 桶名称 */
BucketName?: string;
/** 总文件数 */
TotalFiles?: number;
/** 被识别出的敏感数据数 */
SensitiveDataNums?: number;
/** Bucket扫描的结束时间,格式如:2006-01-02 15:04:05 */
EndTime?: string;
/** 数据源名称 */
DataSourceName?: string;
/** Bucket扫描状态,0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败 */
Status?: number;
/** Bucket扫描结果错误信息 */
ErrorInfo?: string;
/** 资源所在地域 */
ResourceRegion?: string;
/** 是否超额 */
OverSize?: string;
/** 任务实例id */
TaskInstanceId?: string;
/** 开始时间 */
StartTime?: string;
}
/** 云上资源元数据 */
declare interface DspaCloudResourceMeta {
/** 用户资源ID。 */
ResourceId: string;
/** 资源名称。 */
ResourceName: string;
/** 资源VIP。 */
ResourceVip: string;
/** 资源端口。 */
ResourceVPort: number;
/** 资源被创建时间。 */
ResourceCreateTime: string;
/** 用户资源VPC ID 字符串。 */
ResourceUniqueVpcId: string;
/** 用户资源Subnet ID 字符串。 */
ResourceUniqueSubnetId: string;
}
/** DSPA数据分类分布 */
declare interface DspaDataCategoryDistributed {
/** 数据分类ID */
CategoryId?: number;
/** 数据分类名称 */
CategoryName?: string;
/** 数据分类统计个数 */
Count?: number;
/** 分类路径 */
CategoryFullPath?: string;
}
/** 过滤内容 */
declare interface DspaDataSourceMngFilter {
/** 过滤类型。 */
Name: string;
/** 过滤类型的值。 */
Values: string[];
}
/** COS敏感数据识别规则 */
declare interface DspaDiscoveryCOSDataRule {
/** 只能取and 、or两个值其中之一,and:字段和内容同时满足,or:字段和内容满足其一.默认值为or */
Operator?: string;
/** 规则内容 */
Contents?: DspaDiscoveryDataContent[];
}
/** 分类分级任务COS识别规则 */
declare interface DspaDiscoveryCOSRules {
/** 规则状态;0 不启用, 1 启用 */
Status?: number;
/** regex规则内容 */
RegexRule?: DspaDiscoveryCOSDataRule;
/** 关键词规则内容组,最大支持5个关键词。 */
KeywordRule?: DspaDiscoveryCOSDataRule;
/** 忽略词规则内容组,最大支持5个忽略词。 */
IgnoreStringRule?: DspaDiscoveryCOSDataRule;
/** 最大匹配距离,默认值为100。上限为500. */
MaxMatch?: number;
}
/** COS扫描任务结果详情 */
declare interface DspaDiscoveryCOSTaskResultDetail {
/** 任务ID */
TaskId?: number;
/** 扫描File结果详情ID */
FileResultId?: number;
/** 所属桶名 */
BucketName?: string;
/** 所属文件名 */
FileName?: string;
/** 敏感数据分类ID */
CategoryId?: number;
/** 敏感数据分类名称 */
CategoryName?: string;
/** 敏感数据分级ID */
LevelId?: number;
/** 敏感数据分级名称 */
LevelName?: string;
/** KMS加密,true or false */
KMSEncrypted?: boolean;
/** 规则名称 */
RuleName?: string;
/** 规则ID */
RuleId?: number;
/** 敏感数据分级分数 */
LevelRiskScore?: number;
/** 文件大小,单位为KB */
FileSize?: number;
/** 文件类型,如csv,txt */
FileType?: string;
/** 敏感数据出现次数 */
SensitiveDataCount?: number;
/** 分类树路径 */
CategoryFullPath?: string[];
/** 分类树路径 */
CategoryArr?: string[];
/** 合规组ID */
ComplianceId?: number;
/** 结果id */
ResultId?: number;
}
/** 合规组 */
declare interface DspaDiscoveryComplianceGroup {
/** 合规组ID */
ComplianceGroupId?: number;
/** 合规组名称 */
Name?: string;
/** 合规组描述信息 */
Description?: string;
/** 合规组类型;0 默认合规组,1 系统合规组(除默认合规组外), 2 自定义合规组 */
ComplianceGroupType?: number;
/** 合规组对应的规则项 */
ComplianceGroupRules?: DspaDiscoveryComplianceGroupRuleInfo[];
/** 合规组对应的分级组ID */
LevelGroupId?: number;
}
/** 合规组信息 */
declare interface DspaDiscoveryComplianceGroupInfo {
/** 合规组ID */
ComplianceGroupId?: number;
/** 合规组名称 */
Name?: string;
/** 合规组描述信息 */
Description?: string;
/** 合规组类型;0 默认合规组,1 系统合规组(除默认合规组外), 2 自定义合规组 */
ComplianceGroupType?: number;
/** 合规组对应的规则项 */
ComplianceGroupRules?: DspaDiscoveryComplianceGroupRule[];
/** 合规组对应的分级组ID */
LevelGroupId?: number;
/** 是否禁止使用(true,禁止使用,false,可以使用) */
Disabled?: boolean;
/** 是否别名 */
IsAlias?: boolean;
/** 1代表模版开启,0代表模版关闭 */
Status?: number;
/** 模版最后修改时间 */
ModifyTime?: string;
}
/** 合规组中规则信息,用于合规组列表中规则信息展示 */
declare interface DspaDiscoveryComplianceGroupRule {
/** 敏感数据识别规则ID */
RuleId?: number;
/** 敏感数据识别规则名称 */
RuleName?: string;
/** 敏感数据分类ID */
CategoryId?: number;
/** 敏感数据分级ID, 目前只支持高、中、低三级 */
LevelId?: number;
/** 合规组对应的分类信息 */
CategoryName?: string;
/** 分级名称 */
LevelRiskName?: string;
}
/** 合规组中规则信息,用于合规组列表中规则信息展示 */
declare interface DspaDiscoveryComplianceGroupRuleInfo {
/** 敏感数据识别规则ID */
RuleId?: number;
/** 敏感数据识别规则名称 */
RuleName?: string;
/** 敏感数据分类ID */
CategoryId?: number;
/** 敏感数据分级ID, 目前只支持高、中、低三级 */
LevelId?: number;
}
/** 扫描规则内容 */
declare interface DspaDiscoveryDataContent {
/** 规则内容,可以是正则规则,关键词,忽略词扥 */
RuleContent?: string;
/** 是否区分大小写false: 不区分大小写true:区分大小写 */
IsIgnoreCase?: boolean;
}
/** 敏感数据识别规则 */
declare interface DspaDiscoveryDataRule {
/** 规则类型;取值:keyword 关键字, regex 正则 */
RuleType: string;
/** 内容 */
RuleContent: string;
/** 该字段是针对规则类型RuleType为keyword类型时的一个扩展属性 */
ExtendParameters?: DatagovRuleExtendParameter[];
}
/** 敏感数据识别规则集 */
declare interface DspaDiscoveryDataRules {
/** 操作符;只能取and, or的其中一种 */
Operator: string;
/** 规则 */
Contents: DspaDiscoveryDataRule[];
}
/** 敏感数据分级信息 */
declare interface DspaDiscoveryLevelDetail {
/** 分级组名称,唯一性约束,最多60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
LevelGroupName?: string;
/** 分级组来源,0为内置,1为自定义 */
Source?: number;
/** 分级组描述,最多1024字符 */
LevelGroupDesc?: string;
/** 具体分级标识详情 */
LevelDetail?: LevelItem[];
/** 引用合规组次数 */
RefComplianceCnt?: number;
/** 引用合规组 */
RefCompliance?: DspaDiscoveryComplianceGroup[];
/** 分级组ID */
LevelGroupId?: number;
}
/** 分类分级任务RDB数据规则 */
declare interface DspaDiscoveryRDBRules {
/** 规则状态;0 不启用, 1 启用 */
Status: number;
/** 只能取and 、or两个值其中之一,and:字段和内容同时满足,or:字段和内容满足其一 */
MatchOperator: string;
/** 字段名包含规则,最大支持选择9项 */
MetaRule: DspaDiscoveryDataRules;
/** 内容包含规则,最大支持选择9项 */
ContentRule: DspaDiscoveryDataRules;
}
/** 敏感数据扫描任务识别规则详情 */
declare interface DspaDiscoveryRuleDetail {
/** 规则ID */
RuleId?: number;
/** 规则名称 */
Name?: string;
/** 规则描述 */
Description?: string;
/** 规则来源,取值:0 内置, 1 自定义 */
Source?: number;
/** RDB规则详情 */
RDBRules?: DspaDiscoveryRDBRules;
/** COS规则详情 */
COSRules?: DspaDiscoveryCOSRules;
/** 0关闭,1开启 */
Status?: number;
}
/** 分类分级任务相关信息 */
declare interface DspaDiscoveryTask {
/** 任务ID */
TaskId?: number;
/** 任务名称 */
Name?: string;
/** 任务描述 */
Description?: string;
/** 执行周期,0单次 1每天 2每周 3每月 */
Period?: number;
/** 执行计划,0立即 1定时 */
Plan?: number;
/** 任务开关;1 打开,0 关闭 */
Enable?: number;
/** 元数据对象信息 */
DataSourceInfo?: DspaDiscoveryTaskDataSource;
/** 通用规则集开关,0 关闭,1 启用 */
GeneralRuleSetEnable?: number;
/** 任务最新的一次执行结果信息,该字段用于查询任务列表接口 */
Result?: ScanTaskResult;
/** 定时开始时间 */
TimingStartTime?: string | null;
/** 关联模板是否更新 */
ComplianceUpdate?: boolean;
/** full:全量扫描 incre:变更扫描 */
ScanRange?: string;
}
/** 描述对象存储类敏感识别扫描人元数据条件。 */
declare interface DspaDiscoveryTaskCOSCondition {
/** 数据桶名称 */
Bucket?: string;
/** 文件类型 */
FileTypes?: string[];
/** 文件大小上限,单位为KB,如1000, 目前单个文件最大只支持1GB(1048576KB) */
FileSizeLimit?: number;
}
/** 扫描任务数据源信息 */
declare interface DspaDiscoveryTaskDataSource {
/** 数据源ID */
DataSourceId?: string;
/** 用于传入的数据源的条件,可以选择多个数据库,数据库之间通过逗号分隔,如果为空,默认是全部数据库 */
Condition?: string;
/** 代理地址 */
ProxyAddress?: string[];
/** 数据源名称 */
DataSourceName?: string;
/** 资源所在地域 */
ResourceRegion?: string;
/** 数据源类型 */
DataSourceType?: string;
}
/** 扫描任务结果,按照数据库级别展示 */
declare interface DspaDiscoveryTaskDbResult {
/** 扫描数据库结果ID */
DbResultId?: number;
/** 任务ID */
TaskId?: number;
/** 任务名称 */
TaskName?: string;
/** 扫描任务最新一次扫描结果ID */
ResultId?: number;
/** 数据源ID */
DataSourceId?: string;
/** 数据库名称 */
DbName?: string;
/** 总表数 */
TotalTables?: number;
/** 敏感表数 */
SensitiveTables?: number;
/** DB扫描的结束时间,格式如:2006-01-02 15:04:05 */
EndTime?: string;
/** 数据源名称 */
DataSourceName?: string;
/** DB扫描状态,0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败 */
Status?: number;
/** DB扫描结果错误信息 */
ErrorInfo?: string;
/** 资源所在地域 */
ResourceRegion?: string;
/** 敏感字段数 */
SensitiveField?: number;
/** 总的字段数 */
TotalField?: number;
/** 任务实例id */
TaskInstanceId?: string;
/** 开始时间 */
StartTime?: string;
/** 扫描范围(full:全量扫描 incre:变更扫描) */
ScanRange?: string;
}
/** 敏感数据扫描任务相关信息 */
declare interface DspaDiscoveryTaskDetail {
/** 任务名称 */
Name?: string;
/** 任务描述 */
Description?: string;
/** 执行周期,0单次 1每天 2每周 3每月 */
Period?: number;
/** 执行计划,0立即 1定时 */
Plan?: number;
/** 任务开关;1 打开,0 关闭 */
Enable?: number;
/** 元数据对象信息 */
DataSourceInfo?: DspaDiscoveryTaskDataSource;
/** 通用规则集开关,0 关闭,1 启用 */
GeneralRuleSetEnable?: number;
/** 当创建任务时,用户打开了通用规则集开关,则该字段就会保存默认合规组信息 */
DefaultComplianceInfo?: ScanTaskComplianceInfo[];
/** 该任务中用户选择的合规组信息列表 */
CustomComplianceInfo?: ScanTaskComplianceInfo[];
/** 定时开始时间 */
TimingStartTime?: string;
/** full:全量扫描 incre:变更扫描 */
ScanRange?: string;
}
/** 扫描任务结果详情 */
declare 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;
/** 保护措施 */
SafeGuard?: DspaSafeGuard;
/** 分类路径 */
CategoryFullPath?: string;
/** 模式名 */
SchemaName?: string;
}
/** 数据样本 */
declare interface DspaFieldResultDataSample {
/** 数据样本 */
DataSample?: string;
}
/** Dspa实例信息 */
declare interface DspaInstance {
/** DSPA实例ID。 */
DspaId?: string;
/** DSPA实例名称。 */
DspaName?: string;
/** DSPA实例描述信息。 */
DspaDescription?: string;
/** DSPA实例已授权的数据库实例数量。 */
DBAuthCount?: number;
/** DSPA实例已绑定的cos桶数量。 */
CosBindCount?: number;
/** DSPA实例版本。 */
InstanceVersion?: string;
/** DSPA实例状态。 */
Status?: string;
/** 实例过期时间戳。 */
ExpiredAt?: number;
/** 账户APPID。 */
AppId?: number;
/** 体验版本信息。 */
TrialVersion?: string;
/** 体验版本过期时间戳。 */
TrialEndAt?: number;
/** DB已购配额。 */
DbTotalQuota?: number;
/** COS已购配额。 */
CosTotalQuota?: number;
/** COS配额单位,例如:TB。 */
CosQuotaUnit?: string;
/** 0: 默认状态(用户未设置)1: 开启自动续费2: 明确不自动续费 */
RenewFlag?: number;
/** 实例渠道 */
Channel?: string;
/** 已授权的实例数量 */
InsAuthCount?: number;
/** 已购买的实例数量 */
InsTotalQuota?: number;
}
/** RDB关系型数据库敏感数据资产统计 */
declare interface DspaRDBDataAssetCount {
/** 数组资产类型,0代表关系型数据库资产,1代表对象存储COS资产 */
DataAssetType?: number;
/** 已扫描的数据库的个数 */
TotalDbCnt?: number;
/** 数据库表的个数 */
TotalTableCnt?: number;
/** 敏感数据类型个数 */
SensitiveCategoryCnt?: number;
/** 敏感字段的个数 */
SensitiveFieldCnt?: number;
/** 敏感等级分布 */
SensitiveLevel?: SensitiveLevel[];
/** 敏感数据库的个数 */
SensitiveDbCnt?: number;
/** 敏感数据库表的个数 */
SensitiveTableCnt?: number;
/** 扫描字段的个数 */
TotalFieldCnt?: number;
/** 数据分类分布 */
CategoryDistributed?: DspaDataCategoryDistributed[];
}
/** 关系型数据库资产详情 */
declare interface DspaRDBDataAssetDetail {
/** 数据源ID */
DataSourceId?: string;
/** 数据库类型 */
DbType?: string;
/** 数据库名称 */
DbName?: string;
/** 数据库表名称 */
TableName?: string;
/** 数据库表字段名称 */
FieldName?: string;
/** 规则名称 */
RuleName?: string;
/** 数据分类 */
CategoryName?: string;
/** 敏感等级 */
LevelRiskName?: string;
/** 分级风险分数,1-10,最小值为1,最大值为10 */
LevelRiskScore?: number;
/** 可信分 */
TrustedScore?: string;
/** 资源所在地域 */
ResourceRegion?: string;
/** 字段扫描结果ID */
FieldResultId?: string;
/** 规则ID */
RuleId?: number;
/** 分级ID */
LevelId?: number;
/** 分类ID */
CategoryId?: number;
/** 数据源名称 */
DataSourceName?: string;
/** 保护措施 */
SafeGuard?: DspaSafeGuard;
/** 分类路径 */
CategoryFullPath?: string;
/** 0.系统识别,1人工打标 */
IdentifyType?: number;
/** 0未核查 1已核查 */
CheckStatus?: number;
/** 0非敏感,1敏感 */
IsSensitiveData?: number;
/** 模式名 */
SchemaName?: string;
}
/** 资源账户信息 */
declare interface DspaResourceAccount {
/** 资源ID。 */
ResourceId: string;
/** 用户名。 */
UserName: string;
/** 密码。 */
Password: string;
}
/** 分类分级扫描结果字段的保护措施 */
declare interface DspaSafeGuard {
/** 加密状态,可取值如下:UNSET 未设置DISABLE 规则设置未启用ENABLE 规则设置并启用 */
Encrypt?: string;
/** 脱敏状态,可取值如下:UNSET 未设置DISABLE 规则设置未启用ENABLE 规则设置并启用 */
Desensitization?: string;
}
/** 任务执行结果描述。 */
declare interface DspaTaskResult {
/** 任务结果。 */
Result?: string;
/** 结果描述。 */
ResultDescription?: string;
/** 资源ID。 */
ResourceId?: string;
/** 资源类型。 */
MetaType?: string;
}
/** DSPA用户资源元信息 */
declare interface DspaUserResourceMeta {
/** 用户资源ID。 */
ResourceId: string;
/** 资源名称。 */
ResourceName: string;
/** 资源VIP。 */
ResourceVip: string;
/** 资源端口。 */
ResourceVPort: number;
/** 资源被创建时间。 */
ResourceCreateTime: string;
/** 用户资源VPC ID 字符串。 */
ResourceUniqueVpcId: string;
/** 用户资源Subnet ID 字符串。 */
ResourceUniqueSubnetId: string;
/** 用户资源类型信息。 */
MetaType?: string;
/** 资源所处地域。 */
ResourceRegion?: string;
/** 资源被同步时间。 */
ResourceSyncTime?: string;
/** 资源被授权状态。 */
AuthStatus?: string;
/** 资源创建类型,cloud-云原生资源,build-用户自建资源。 */
BuildType?: string;
/** 主实例ID。 */
MasterInsId?: string;
/** 用户资源VPC ID 整数。 */
ResourceVpcId?: number;
/** 用户资源Subnet ID 整数。 */
ResourceSubnetId?: number;
/** 协议类型。 */
Protocol?: string;
/** 资源版本号。 */
ResourceVersion?: string;
/** 授权方式 */
ResourceAuthType?: string;
/** 授权账号名 */
ResourceAuthAccount?: string;
/** 实例类型 */
InstanceType?: string;
/** 实例值 */
InstanceValue?: string;
/** //治理授权状态(0:关闭 1:开启) */
GovernAuthStatus?: number;
/** 授权范围:all - 授权整个数据源 manual:手动指定数据源 */
AuthRange?: string;
}
/** es的资产统计结果 */
declare interface ESAsset {
/** 索引总数量 */
IndexNums?: number;
/** 敏感索引的数量 */
SensitiveIndexNums?: number;
/** 字段数量 */
FieldNums?: number;
/** 敏感的字段数量 */
SensitiveFieldNums?: number;
}
/** es敏感资产详情列表 */
declare interface ESAssetDBDetail {
/** 数据源id */
DataSourceId?: string;
/** 索引名称 */
IndexName?: string;
/** 数据库类型 */
DataType?: string;
/** 字段的数量 */
FieldNums?: number;
/** 敏感字段的数量 */
SensitiveFieldNums?: number;
/** 敏感数据分布 */
DistributionData?: Note[];
}
/** ES的概览页统计数据 */
declare interface ESDataAssetCountDto {
/** es */
DataAssetType?: number;
/** 敏感索引个数 */
SensitiveIndexCnt?: number;
/** 总的索引个数 */
TotalIndexCnt?: number;
/** 敏感字段个数 */
SensitiveFieldCnt?: number;
/** 总的字段个数 */
TotalFieldCnt?: number;
/** 敏感分类的个数 */
SensitiveCategoryCnt?: number;
/** 敏感分级的分布 */
SensitiveLevel?: SensitiveLevel[];
/** 敏感分类的分布 */
CategoryDistributed?: DspaDataCategoryDistributed[];
}
/** ES的概览页资产详情 */
declare interface ESDataAssetDetail {
/** id */
FieldResultId?: number;
/** 数据源id */
DataSourceId?: string;
/** 数据源名称 */
DataSourceName?: string;
/** 类型 */
DataSourceType?: string;
/** 地域信息 */
ResourceRegion?: string;
/** 索引名称 */
IndexName?: string;
/** 字段名称 */
FieldName?: string;
/** 分类id */
CategoryId?: number;
/** 分类名称 */
CategoryName?: string;
/** 分类路径数组 */
CategoryArr?: string[];
/** 等级id */
LevelId?: number;
/** 分级名称 */
LevelRiskName?: string;
/** 分级分数 */
LevelRiskScore?: number;
/** 可信分 */
TrustedScore?: number;
/** 规则id */
RuleId?: number;
/** 规则名称 */
RuleName?: string;
/** 0系统识别,1人工打标 */
IdentifyType?: number;
/** 0未核查,1已核查 */
CheckStatus?: number;
}
/** 创建评估任务的ES详情 */
declare interface ESInstance {
/** 数据源id */
DataSourceId: string;
/** 数据源类型 */
DataSourceType: string;
/** 地域 */
ResourceRegion: string;
/** 扫描任务ID */
DiscoveryTaskId?: number;
/** 扫描任务实例ID */
DiscoveryTaskInstanceID?: number;
}
/** ES扫描任务结果详情 */
declare interface ESTaskResultDetail {
/** id */
Id?: number;
/** 任务id */
TaskId?: number;
/** 字段名称 */
FieldName?: string;
/** 规则id */
RuleId?: number;
/** 规则名称 */
RuleName?: string;
/** 分类id */
CategoryId?: number;
/** 分类名称 */
CategoryName?: string;
/** 多级分类的路径 */
CategoryArr?: string[];
/** 分级id */
LevelId?: number;
/** 分级名称 */
LevelName?: string;
/** 分级分数 */
LevelRiskScore?: number;
}
/** 错误信息描述 */
declare interface ErrDescription {
/** 错误码。 */
ErrCode?: string;
/** 具体错误信息。 */
ErrMessage?: string;
}
/** 描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 */
declare interface Filter {
/** 需要过滤的字段。 */
Name: string;
/** 字段的过滤值。 */
Values: string[];
}
/** 高风险资产详情信息 */
declare interface HighRiskAssetsDetail {
/** 实例id */
InstanceId?: string;
/** 数据源类型 */
DataSourceType?: string;
/** 数据源名称 */
DataSourceName?: string;
/** 资产对象名称 */
AssetsName?: string;
/** 高风险个数 */
HighRiskCount?: number;
/** 风险类型 */
RiskType?: string;
/** 总的风险个数 */
TotalRiskCount?: number;
/** 风险面 */
RiskSide?: string;
/** 地域 */
ResourceRegion?: string;
}
/** 某个分级单个信息 */
declare interface ItemLevel {
/** 分级标识名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
LevelRiskName: string;
/** 分级标识对应的风险分数值,1-10,最小为1,最大为10 */
LevelRiskScore: number;
}
/** 分级单项信息 */
declare interface LevelItem {
/** 分级ID */
LevelId: number;
/** 分级组ID */
LevelGroupId: number;
/** 分级标识名称,支持内置分级,内置分级取值:高,中,低,也可以自定义 */
LevelRiskName: string;
/** 分级风险分数,1-10,最小值为1,最大值为10 */
LevelRiskScore: number;
}
/** mongo的资产统计结果 */
declare interface MongoAsset {
/** DB总数量 */
DbNums?: number;
/** 敏感DB数量 */
SensitiveDbNums?: number;
/** 集合数量 */
ColNums?: number;
/** 敏感集合的数量 */
SensitiveColNums?: number;
/** 字段数量 */
FieldNums?: number;
/** 敏感的字段数量 */
SensitiveFieldNums?: number;
}
/** mongo敏感资产详情列表 */
declare interface MongoAssetDBDetail {
/** 数据源id */
DataSourceId?: string;
/** 数据库名称 */
DdName?: string;
/** 数据库类型 */
DataType?: string;
/** 集合的数量 */
ColNums?: number;
/** 敏感集合数量 */
SensitiveColNums?: number;
/** 字段的数量 */
FieldNums?: number;
/** 敏感字段的数量 */
SensitiveFieldNums?: number;
/** 敏感数据分布 */
DistributionData?: Note[];
}
/** NOSQL类型的数据源实例 */
declare interface NOSQLInstance {
/** 数据源id */
DataSourceId: string;
/** cdb, dcdb, mariadb, postgres, cynosdbpg, cynosdbmysql, cos, mysql_like_proto, postgre_like_proto,mongodb */
DataSourceType: string;
/** 资源所在地域 */
ResourceRegion: string;
/** 根据实例创建的敏感数据识别扫描任务Id */
DiscoveryTaskId?: number;
/** 敏感数据识别任务实例id */
DiscoveryTaskInstanceID?: number;
}
/** 数据资产报告-各种key-value的展示数据结构 */
declare interface Note {
/** 通用key,例如分类名称 */
Key?: string;
/** 通用value,例如分类个数 */
Value?: number;
}
/** 权限风险详情 */
declare interface PrivilegeRisk {
/** 账户名 */
AccountName?: string[];
/** 表名称 */
TableName?: string;
/** 说明 */
Description?: string;
}
/** 处理历史 */
declare interface ProcessHistory {
/** 处理时间 */
Time?: string;
/** 状态 */
Status?: number;
/** 处理人 */
Handler?: string;
/** 备注 */
Note?: string;
}
/** rdb的资产统计结果 */
declare interface RDBAsset {
/** DB总数量 */
DbNums?: number;
/** 敏感DB数量 */
SensitiveDbNums?: number;
/** 表数量 */
TableNums?: number;
/** 敏感表的数量 */
SensitiveTableNums?: number;
/** 字段数量 */
FieldNums?: number;
/** 敏感的字段数量 */
SensitiveFieldNums?: number;
}
/** RDB实例信息 */
declare interface RDBInstance {
/** 数据源Id */
DataSourceId: string;
/** cdb, dcdb, mariadb, postgres, cynosdbpg, cynosdbmysql, cos, mysql_like_proto, postgre_like_proto */
DataSourceType: string;
/** 资源所在地域 */
ResourceRegion: string;
/** 若未来扩展到DBName粒度,可采用 */
DBs?: DBStatements[];
}
/** 报表信息 */
declare interface ReportInfo {
/** 任务id */
Id?: number;
/** 报告名称 */
ReportName?: string;
/** 报告类型(AssetSorting:资产梳理) */
ReportType?: string;
/** 报告周期(0单次 1每天 2每周 3每月) */
ReportPeriod?: number;
/** 执行计划 (0:单次报告 1:定时报告) */
ReportPlan?: number;
/** 报告导出状态(Success 成功, Failed 失败, InProgress 进行中) */
ReportStatus?: string;
/** 任务下次启动时间 */
TimingStartTime?: string;
/** 创建时间 */
CreateTime?: string;
/** 完成时间 */
FinishedTime?: string;
/** 子账号uin */
SubUin?: string;
/** 失败信息 */
FailedMessage?: string;
/** 是否启用(0:否 1:是) */
Enable?: number;
/** 识别模板名称 */
ComplianceName?: string;
/** 进度百分比 */
ProgressPercent?: number;
/** 报告模版名称 */
ReportTemplateName?: string;
}
/** 待处理风险项数量信息 */
declare interface RiskCountInfo {
/** 风险等级 */
RiskLevel: string;
/** 该等级风险项数量 */
Count: number;
/** 风险等级名称 */
RiskLevelName: string;
}
/** 风险趋势项 */
declare interface RiskDealedTrendItem {
/** 日期 */
Date?: string;
/** 未解决数量 */
Unhandled?: number;
/** 已解决数量 */
Handled?: number;
/** 新发现 */
NewDiscoveryHandled?: number;
}
/** 风险TOP5统计项 */
declare interface RiskItem {
/** 名称 */
ItemName: string;
/** 风险数量 */
RiskNum: number;
}
/** 最新的风险详情信息数据 */
declare interface RiskItemInfo {
/** 最新风险项id */
Id?: number;
/** 数据源id */
DataSourceId?: string;
/** 数据源名称 */
DataSourceName?: string;
/** 数据源类型 */
DataSourceType?: string;
/** 资源地域 */
ResourceRegion?: string;
/** 资产名称 */
AssetName?: string;
/** 风险类型 */
RiskType?: string;
/** 风险项 */
RiskName?: string;
/** 风险级别 */
RiskLevel?: string;
/** 风险描述 */
RiskDescription?: string;
/** 建议措施 */
SuggestAction?: string;
/** 安全产品(可能有多个) */
SecurityProduct?: SecurityProduct[];
/** 状态(waiting:待处理,processing:处理中,finished:已处理,ignored:已忽略) */
Status?: number;
/** 扫描时间 */
ScanTime?: string;
/** 最后处置时间 */
LastProcessTime?: string;
/** 分类分级合规组Id */
IdentifyComplianceId?: number;
/** 类型 */
ItemSubType?: string;
/** 风险面 */
RiskSide?: string;
/** API安全风险链接 */
APIRiskLinkURL?: string;
/** 备注 */
Remark?: string;
}
/** 风险级别详情的矩阵 */
declare interface RiskLevelMatrix {
/** 存储id */
Id?: number;
/** 分类分级levelID */
SensitiveLevelId?: number;
/** 分类分级名称 */
SensitiveLevelName?: string;
/** 漏洞级别 */
VulnerabilityLevel?: string;
/** 风险级别 */
RiskLevel?: string;
}
/** 风险等级列表 */
declare interface RiskLevelRisk {
/** 风险id */
Id?: number;
/** 风险等级列表 */
RiskLevelName?: string;
/** 风险级别描述 */
RiskLevelDescription?: string;
/** 引用的分类分级模板 */
IdentifyComplianceName?: string;
/** 类型,区分自定义还是系统内置 */
Type?: string;
}
/** 风险级别趋势项 */
declare interface RiskLevelTrendItem {
/** 日期 */
Date: string;
/** 高风险数量 */
High: number;
/** 中风险数量 */
Medium: number;
/** 低风险数量 */
Low: number;
/** 总数 */
Total: number;
}
/** 用于生成默认的风险级别矩阵 */
declare interface RiskMatrixLevel {
/** 名称 */
Name?: string;
/** 就是id */
Id?: number;
/** 分数 */
Score?: number;
}
/** 风险面的分布 */
declare interface RiskSideDistributed {
/** 风险面 */
AssessmentRiskSide?: Note;
/** 风险类型 */
AssessmentRisk?: Note[];
}
/** 数据资产报告-rdb的敏感数据规则分布 */
declare interface RuleDistribution {
/** 规则id */
RuleId?: number;
/** 规则名称 */
RuleName?: string;
/** 分级id */
LevelId?: number;
/** 分级名称 */
LevelName?: string;
/** 规则数量 */
RuleCnt?: number;
}
/** 分类分级规则数量 */
declare interface RuleEffectItem {
/** 规则描述 */
Name?: string;
/** 规则值 */
Value?: number;
}
/** 敏感识别任务COS识别规则 */
declare interface ScanTaskCOSRules {
/** regex规则内容 */
RegexRule: COSDataRule;
/** 规则状态;0 不启用, 1 启用 */
Status?: number;
/** 关键词规则内容组,最大支持5个关键词。 */
KeywordRule?: COSDataRule;
/** 忽略词规则内容组,最大支持5个忽略词。 */
IgnoreStringRule?: COSDataRule;
/** 最大匹配距离,默认值为100。上限为500. */
MaxMatch?: number;
}
/** 扫描任务选择的合规组信息 */
declare interface ScanTaskComplianceInfo {
/** 合规组ID */
ComplianceGroupId: number;
/** 合规组名称 */
ComplianceGroupName: string;
}
/** 敏感识别任务RDB数据规则 */
declare interface ScanTaskRDBRules {
/** 规则状态;0 不启用, 1 启用 */
Status: number;
/** 只能取and 、or两个值其中之一,and:字段和内容同时满足,or:字段和内容满足其一 */
MatchOperator: string;
/** 字段名包含规则,最大支持选择9项 */
MetaRule: DataRules;
/** 内容包含规则,最大支持选择9项 */
ContentRule: DataRules;
}
/** 扫描任务结果信息 */
declare interface ScanTaskResult {
/** 任务最新一次运行结果ID */
Id?: number;
/** 任务扫描结束的时间,格式如:2021-12-12 12:12:12 */
EndTime?: string;
/** 任务状态,-1待触发 0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败 */
Status?: number;
/** 扫描任务结果展示,如果扫描失败,则显示失败原因 */
Result?: string;
/** 结果描述 */
ResultDescription?: string;
/** 结果建议 */
Suggestion?: string;
/** 扫描进度 */
Progress?: number;
}
/** 建议使用的安全产品 */
declare interface SecurityProduct {
/** 产品名称 */
ProductName?: string;
/** 产品链接 */
ReferUrl?: string;
}
/** 敏感等级分布 */
declare interface SensitiveLevel {
/** 分级标识ID */
LevelId: number;
/** 分级标识统计 */
LevelCnt: number;
/** 分级标识名称 */
LevelRiskName: string;
/** 分级标识分数 */
LevelRiskScore: number;
}
/** 生成的建议的风险等级矩阵 */
declare interface SuggestRiskLevelMatrix {
/** 矩阵 */
RiskLevelMatrix?: SuggestRiskLevelMatrixItem[];
}
/** 建议生成的二位矩阵的第二层 */
declare interface SuggestRiskLevelMatrixItem {
/** 分类分级等级 */
SensitiveLevel?: RiskMatrixLevel;
/** 脆弱项等级 */
VulnerabilityLevel?: RiskMatrixLevel;
/** 风险名 */
RiskName?: string;
/** 分数 */
RiskScore?: number;
}
/** 评估模板的详情数据 */
declare interface TemplateInfo {
/** 模板id */
TemplateId: number;
/** 模板名称 */
TemplateName: string;
}
/** 数据资产报告-涉敏top的资产 */
declare interface TopAsset {
/** 分级名称 */
LevelName?: string;
/** top数据信息 */
TopStat?: TopAssetStat[];
}
/** 设敏top资产的信息 */
declare interface TopAssetStat {
/** 数据源id */
DataSourceId?: string;
/** db_name */
SubData?: string;
/** 敏感个数 */
SensitiveCnt?: number;
}
declare interface AuthorizeDSPAMetaResourcesRequest {
/** DSPA实例ID。 */
DspaId: string;
/** 授权方式,可选:automatic(一键自动授权) 、 account(指定用户名授权)。 */
AuthType: string;
/** 资源类型。 */
MetaType: string;
/** 资源所处地域。 */
ResourceRegion: string;
/** 用户授权的账户信息,如果是一键自动授权模式,则不需要填写账户名与密码。 */
ResourcesAccount: DspaResourceAccount[];
/** 创建默认主模板扫描任务 */
CreateDefaultTask?: boolean;
/** 授权范围(all:授权整个数据源 manual:手动指定数据库) */
AuthRange?: string;
}
declare interface AuthorizeDSPAMetaResourcesResponse {
/** DSPA实例ID。 */
DspaId?: string;
/** 授权结果。 */
Results?: DspaTaskResult[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindDSPAResourceCosBucketsRequest {
/** DSPA实例ID。 */
DspaId: string;
/** 绑定的COS桶信息。 */
BindCosResourceItems?: CosResourceItem[];
/** 解绑的COS桶信息。 */
UnbindCosResourceItems?: CosResourceItem[];
}
declare interface BindDSPAResourceCosBucketsResponse {
/** 绑定结果数组 */
CosTaskResults?: CosTaskResult[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindDSPAResourceDatabasesRequest {
/** DSPA实例ID。 */
DspaId: string;
/** 数据库实例ID。 */
ResourceId: string;
/** 数据库实例类型。 */
MetaType: string;
/** 绑定DB列表。 */
BindDbItems?: DbResourceItem[];
/** 解绑DB列表。 */
UnbindDbItems?: DbResourceItem[];
}
declare interface BindDSPAResourceDatabasesResponse {
/** 绑定结果数组 */
DbTaskResults?: DbTaskResult[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CopyDSPATemplateRequest {
/** DSPA实例ID */
DspaId: string;
/** 合规组ID */
TemplateId: number;
}
declare interface CopyDSPATemplateResponse {
/** 模板id */
TemplateId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAssetSortingReportRetryTaskRequest {
/** 任务id */
ReportTaskId: number;
/** dspa实例id */
DspaId: string;
}
declare interface CreateAssetSortingReportRetryTaskResponse {
/** 任务id */
ReportTaskId?: number;
/** 提示信息 */
Remark?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAssetSortingReportTaskRequest {
/** dspa实例id */
DspaId: string;
/** 识别模板id */
ComplianceId: number;
/** 选中资产列表 */
AssetList: AssetList[];
}
declare interface CreateAssetSortingReportTaskResponse {
/** 报表任务id */
ReportTaskId?: number;
/** 提示信息 */
Remark?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPAAssessmentRiskLevelRequest {
/** dspa实例id */
DspaId: string;
/** 风险等级名称 */
RiskLevelName: string;
/** 识别模板 */
IdentifyComplianceId: number;
/** 风险等级矩阵 */
RiskLevelRule: RiskLevelMatrix[];
/** 风险等级的描述 */
RiskLevelDescription?: string;
}
declare interface CreateDSPAAssessmentRiskLevelResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPAAssessmentRiskTemplateRequest {
/** dspa实例id */
DspaId: string;
/** 模板名称 */
TemplateName: string;
/** 风险等级id */
RiskLevelId: number;
/** 风险id列表 */
RiskIdList: number[];
/** 模板描述 */
TemplateDescription?: string;
}
declare interface CreateDSPAAssessmentRiskTemplateResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPAAssessmentTaskRequest {
/** DSPA实例Id,格式“dspa-xxxxxxxx” */
DspaId: string;
/** 评估任务名称。1-20个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字 */
Name: string;
/** 评估模板Id,格式“template-xxxxxxxx” */
TemplateId: string;
/** 评估业务名称。1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字 */
BusinessName?: string;
/** 业务所属部门。1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字 */
BusinessDept?: string;
/** 业务负责人。1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字 */
BusinessOwner?: string;
/** 分类分级模板Id */
ComplianceId?: number;
/** 敏感数据扫描数据源条件。 */
DiscoveryCondition?: DiscoveryCondition;
/** 说明 */
Description?: string;
}
declare interface CreateDSPAAssessmentTaskResponse {
/** 评估任务Id,格式“task-xxxxxxxx” */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPACOSDiscoveryTaskRequest {
/** DSPA实例ID */
DspaId: string;
/** 任务名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
Name: string;
/** 数据源ID */
DataSourceId: string;
/** 任务开关,0 关闭,1 启用 */
Enable: number;
/** 桶名 */
Bucket: string;
/** 执行计划, 0立即 1定时,选择“立即”时,扫描周期只能选择单次。 */
Plan: number;
/** 扫描周期,0单次 1每天 2每周 3每月 */
Period: number;
/** 待扫描文件类型,用逗号隔开,格式如:[".txt", ".csv", ".log", ".xml",".html", ".json"]。 */
FileTypes: string[];
/** 文件大小上限,单位为KB,如1000, 目前单个文件最大只支持100MB(102400KB) */
FileSizeLimit: number;
/** 资源所在地域 */
ResourceRegion: string;
/** 任务描述,最大长度为1024个字符 */
Description?: string;
/** 通用规则集开关,0 关闭,1 启用 */
GeneralRuleSetEnable?: number;
/** 合规组ID列表,最多支持添加5个 */
ComplianceGroupIds?: number[];
/** 任务定时启动时间,格式如:2006-01-02 15:04:05当执行计划(Plan字段)为”立即“时,定时启动时间不会生效,此场景下给该字段传值不会被保存。 */
TimingStartTime?: string;
}
declare interface CreateDSPACOSDiscoveryTaskResponse {
/** 任务ID */
TaskId?: number;
/** 扫描结果ID */
ResultId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPACategoryRelationRequest {
/** dspa实例id */
DspaId: string;
/** 分类id */
CategoryId: number;
/** 父级分类id(无父级分类传-1) */
ParentCategoryId: number;
/** 分类模板id */
ComplianceId: number;
}
declare interface CreateDSPACategoryRelationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPACategoryRequest {
/** DSPA实例ID */
DspaId: string;
/** 敏感数据分类名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
Name: string;
}
declare interface CreateDSPACategoryResponse {
/** 敏感数据分类ID */
CategoryId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPAComplianceGroupRequest {
/** DSPA实例ID */
DspaId: string;
/** 合规组名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
Name: string;
/** 合规组描述,最大长度为1024个字符 */
Description?: string;
/** 合规组规则配置(参数已废弃,请传空数组) */
ComplianceGroupRules?: ComplianceGroupRuleIdInfo[];
/** 分级组ID,默认值为1,新增参数,可选 */
LevelGroupId?: number;
/** 1代表模版开启,0代表模版关闭 */
Status?: number;
/** 该complianceId的开启状态将被关闭 */
CloseComplianceId?: number;
}
declare interface CreateDSPAComplianceGroupResponse {
/** 合规组ID */
ComplianceGroupId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPAComplianceRulesRequest {
/** dspa实例id */
DspaId: string;
/** 分类id */
CategoryId: number;
/** 合规组模板id */
ComplianceId: number;
/** 规则列表 */
Rules: CreateComplianceRules[];
}
declare interface CreateDSPAComplianceRulesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPACosMetaResourcesRequest {
/** DSPA实例ID。 */
DspaId: string;
/** 资源所处地域。 */
ResourceRegion?: string;
/** COS桶列表 */
Buckets?: string[];
/** 必填,COS资源列表 */
CosBucketItems?: CosBucketItem[];
}
declare interface CreateDSPACosMetaResourcesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPADbMetaResourcesRequest {
/** DSPA实例ID。 */
DspaId: string;
/** 资源类型,支持:cdb(云数据库 MySQL)、dcdb(TDSQL MySQL版)、mariadb(云数据库 MariaDB)、postgres(云数据库 PostgreSQL)、cynosdbpg(TDSQL-C PostgreSQL版)、cynosdbmysql(TDSQL-C MySQL版) */
MetaType: string;
/** 资源所处地域。 */
ResourceRegion?: string;
/** 用来标记本次更新是否已经是最后一次,可选值:continue(后续还需要更新)、finished(本次是最后一次更新)。 */
UpdateStatus?: string;
/** 本次更新的ID号,用来标记一次完整的更新过程。 */
UpdateId?: string;
/** 云上资源列表。 */
Items?: DspaCloudResourceMeta[];
/** 必填,云数据库资源列表。 */
CloudResourceItems?: CloudResourceItem[];
}
declare interface CreateDSPADbMetaResourcesResponse {
/** 本次更新的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?: string;
}
declare interface CreateDSPADiscoveryRuleRequest {
/** DSPA实例ID */
DspaId: string;
/** 规则名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
Name: string;
/** 规则描述,最大长度为1024个字符 */
Description?: string;
/** RDB类敏感数据识别规则 */
RDBRules?: DspaDiscoveryRDBRules;
/** COS类敏感数据识别规则 */
COSRules?: DspaDiscoveryCOSRules;
/** 规则状态;0 不启用, 1 启用 */
Status?: number;
}
declare interface CreateDSPADiscoveryRuleResponse {
/** 规则ID */
RuleId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPADiscoveryTaskRequest {
/** DSPA实例ID */
DspaId: string;
/** 任务名称,1-60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
Name: string;
/** 数据源ID */
DataSourceId: string;
/** 任务开关,0 关闭,1 启用 */
Enable: 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;
/** 通用规则集开关,0 关闭,1 启用 */
GeneralRuleSetEnable?: number;
/** 任务描述,最大长度为1024个字符 */
Description?: string;
/** 用于传入的数据源的条件,目前只支持数据库,所以目前表示数据库的名称,选择多个数据库,之间通过逗号分隔,若不选,则默认选择全部数据库 */
Condition?: string;
/** 此参数必选。合规组ID列表,最多支持添加5个 */
ComplianceGroupIds?: number[];
/** 任务定时启动时间,格式如:2006-01-02 15:04:05当执行计划(Plan字段)为”立即“时,定时启动时间不会生效,此场景下给该字段传值不会被保存。 */
TimingStartTime?: string;
/** random-随机,asc生序,desc降序 */
Order?: string;
/** 抽样的条数,范围30-1000 */
Rows?: number;
/** 抽样的排序字段 */
GlobalOrderField?: string;
/** full:全量扫描 incre:变更扫描 */
ScanRange?: string;
}
declare interface CreateDSPADiscoveryTaskResponse {
/** 任务ID */
TaskId?: number;
/** 扫描结果ID */
ResultId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPALevelGroupRequest {
/** DSPA实例ID */
DspaId: string;
/** 分级组名称,唯一性约束,最多60个字符,仅允许输入中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,Name不可重复 */
Name: string;
/** 分级标识配置 */
ItemLevels: ItemLevel[];
/** 分级组描述,最多1024字符 */
Description?: string;
}
declare interface CreateDSPALevelGroupResponse {
/** 分级组ID */
LevelGroupId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDSPAMetaResourcesRequest {
/** 资源类型,支持:cdb(云数据库 MySQL)、dcdb(TDSQL MySQL版)、mariadb(云数据库 MariaDB)、postgres(云数据库 PostgreSQL)、cynosdbpg(TDSQL-C PostgreSQL版)、cynosdbmysql(TDSQL-C MySQL版) */
MetaType: string;
/** 资源所处地域。 */
ResourceRegion: string;
/** DSPA实例ID。 */
DspaId: string;
/** 用来标记本次更新是否已经是最后一次,可选值:continue(后续还需要更新)、finished(本次是最后一次更新)。 */
UpdateStatus: string;
/** 本次更新的ID号,用来标记一次完整的更新过程。 */
UpdateId: string;
/** 资源列表。 */
Items: DspaUserResourceMe