{ "name": "dsgc", "display_name": "数据安全治理中心", "description": "数据安全治理中心接口", "domain": "other", "api_version": "2019-07-23", "endpoint": "dsgc.tencentcloudapi.com", "actions": [ { "name": "AuthorizeDSPAMetaResources", "description": "授权用户云资源", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2" }, { "name": "AuthType", "type": "string", "required": true, "description": "授权方式，可选：automatic(一键自动授权) 、 account(指定用户名授权)。", "example": "automatic" }, { "name": "MetaType", "type": "string", "required": true, "description": "资源类型。", "example": "cdb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "ResourcesAccount", "type": "array", "required": true, "description": "用户授权的账户信息，如果是一键自动授权模式，则不需要填写账户名与密码。", "example": "admin", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID。", "example": "cdb-a1cb2" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名。", "example": "admin" }, { "name": "Password", "type": "string", "required": true, "description": "密码。", "example": "pass" } ] }, { "name": "CreateDefaultTask", "type": "boolean", "required": false, "description": "创建默认主模板扫描任务", "example": "false" }, { "name": "AuthRange", "type": "string", "required": false, "description": "授权范围（all:授权整个数据源 manual:手动指定数据库）", "example": "all" } ], "required": [ "DspaId", "AuthType", "MetaType", "ResourceRegion", "ResourcesAccount" ] }, { "name": "BindDSPAResourceCosBuckets", "description": "绑定或解绑COS桶", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2c3" }, { "name": "BindCosResourceItems", "type": "array", "required": false, "description": "绑定的COS桶信息。", "example": "[{\"ResourceId\":\"cos-c63fc2d1d3db1a6ebd4a11202e8b5f90b810eb04\",\"ResourceRegion\":\"ap-guangzhou\",\"ResourceName\":\"refer-unset-gz-251007922\"}]", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "cos数据源ID。", "example": "cos-xxxxxx" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "桶所在地域。", "example": "ap-guangzhou" }, { "name": "ResourceName", "type": "string", "required": true, "description": "桶名称。", "example": "bucket-name1" } ] }, { "name": "UnbindCosResourceItems", "type": "array", "required": false, "description": "解绑的COS桶信息。", "example": "[{\"ResourceId\":\"cos-c63fc2d1d3db1a6ebd4a11202e8b5f90b810eb04\",\"ResourceRegion\":\"ap-guangzhou\",\"ResourceName\":\"refer-unset-gz-251007922\"}]", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "cos数据源ID。", "example": "cos-xxxxxx" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "桶所在地域。", "example": "ap-guangzhou" }, { "name": "ResourceName", "type": "string", "required": true, "description": "桶名称。", "example": "bucket-name1" } ] } ], "required": [ "DspaId" ] }, { "name": "BindDSPAResourceDatabases", "description": "绑定或解绑数据库实例DB", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-ab50f3b1" }, { "name": "ResourceId", "type": "string", "required": true, "description": "数据库实例ID。", "example": "cdb-6cmpe42v" }, { "name": "MetaType", "type": "string", "required": true, "description": "数据库实例类型。", "example": "cdb" }, { "name": "BindDbItems", "type": "array", "required": false, "description": "绑定DB列表。", "example": "[{\"DbName\":\"asset\"}]", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "DB名称。", "example": "default" } ] }, { "name": "UnbindDbItems", "type": "array", "required": false, "description": "解绑DB列表。", "example": "[{\"DbName\":\"asset_info\"}]", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "DB名称。", "example": "default" } ] } ], "required": [ "DspaId", "ResourceId", "MetaType" ] }, { "name": "CopyDSPATemplate", "description": "复制合规组模板", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-xxx" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "CreateAssetSortingReportRetryTask", "description": "创建资产梳理报表导出重试任务", "status": "online", "parameters": [ { "name": "ReportTaskId", "type": "integer", "required": true, "description": "任务id", "example": "12987" }, { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2" } ], "required": [ "ReportTaskId", "DspaId" ] }, { "name": "CreateAssetSortingReportTask", "description": "创建资产梳理报告任务", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-ab50f3b1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "识别模板id", "example": "1" }, { "name": "AssetList", "type": "array", "required": true, "description": "选中资产列表", "example": "[ { \"DataSourceType\": \"cdb\", \"DataSourceInfo\": [ { \"DataSourceId\": \"cdb-6cmpe42v\", \"BindList\": [ \"test_csb\" ] } ] } ]", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "CreateDSPAAssessmentRiskLevel", "description": "风险项页面---创建风险等级", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "RiskLevelName", "type": "string", "required": true, "description": "风险等级名称", "example": "默认评估分级模板" }, { "name": "IdentifyComplianceId", "type": "integer", "required": true, "description": "识别模板", "example": "1" }, { "name": "RiskLevelRule", "type": "array", "required": true, "description": "风险等级矩阵", "example": "[ { \"SensitiveLevelId\": 1, \"SensitiveLevelName\": \"高\", \"VulnerabilityLevel\": \"high\", \"RiskLevel\": \"high\" }, { \"SensitiveLevelId\": 1, \"SensitiveLevelName\": \"高\", \"VulnerabilityLevel\": \"medium\", \"RiskLevel\": \"high\" }, { \"SensitiveLevelId\": 1, \"SensitiveLevelName\": \"高\", \"VulnerabilityLevel\": \"low\", \"RiskLevel\": \"medium\" }, { \"SensitiveLevelId\": 2, \"SensitiveLevelName\": \"中\", \"VulnerabilityLevel\": \"high\", \"RiskLevel\": \"high\" }, { \"SensitiveLevelId\": 2, \"SensitiveLevelName\": \"中\", \"VulnerabilityLevel\": \"medium\", \"RiskLevel\": \"medium\" }, { \"SensitiveLevelId\": 2, \"SensitiveLevelName\": \"中\", \"VulnerabilityLevel\": \"low\", \"RiskLevel\": \"low\" }, { \"SensitiveLevelId\": 3, \"SensitiveLevelName\": \"低\", \"VulnerabilityLevel\": \"high\", \"RiskLevel\": \"medium\" }, { \"SensitiveLevelId\": 3, \"SensitiveLevelName\": \"低\", \"VulnerabilityLevel\": \"medium\", \"RiskLevel\": \"low\" }, { \"SensitiveLevelId\": 3, \"SensitiveLevelName\": \"低\", \"VulnerabilityLevel\": \"low\", \"RiskLevel\": \"low\" }, { \"SensitiveLevelId\": 0, \"SensitiveLevelName\": \"NotSensitive\", \"VulnerabilityLevel\": \"high\", \"RiskLevel\": \"low\" }, { \"SensitiveLevelId\": 0, \"SensitiveLevelName\": \"NotSensitive\", \"VulnerabilityLevel\": \"medium\", \"RiskLevel\": \"low\" }, { \"SensitiveLevelId\": 0, \"SensitiveLevelName\": \"NotSensitive\", \"VulnerabilityLevel\": \"low\", \"RiskLevel\": \"low\" } ]", "item_type": "object", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "存储id", "example": "1" }, { "name": "SensitiveLevelId", "type": "integer", "required": false, "description": "分类分级levelID", "example": "1" }, { "name": "SensitiveLevelName", "type": "string", "required": false, "description": "分类分级名称", "example": "高" }, { "name": "VulnerabilityLevel", "type": "string", "required": false, "description": "漏洞级别", "example": "高" }, { "name": "RiskLevel", "type": "string", "required": false, "description": "风险级别", "example": "高" } ] }, { "name": "RiskLevelDescription", "type": "string", "required": false, "description": "风险等级的描述", "example": "默认风险评估分级模板" } ], "required": [ "DspaId", "RiskLevelName", "IdentifyComplianceId", "RiskLevelRule" ] }, { "name": "CreateDSPAAssessmentRiskTemplate", "description": "风险评估模板---创建风险评估模板", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称", "example": "风险评估模板" }, { "name": "RiskLevelId", "type": "integer", "required": true, "description": "风险等级id", "example": "1" }, { "name": "RiskIdList", "type": "array", "required": true, "description": "风险id列表", "example": "[1]", "item_type": "integer" }, { "name": "TemplateDescription", "type": "string", "required": false, "description": "模板描述", "example": "默认风险评估模板" } ], "required": [ "DspaId", "TemplateName", "RiskLevelId", "RiskIdList" ] }, { "name": "CreateDSPAAssessmentTask", "description": "新建DSPA风险评估任务", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "Name", "type": "string", "required": true, "description": "评估任务名称。1-20个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字", "example": "KMS评估任务" }, { "name": "TemplateId", "type": "string", "required": true, "description": "评估模板Id，格式“template-xxxxxxxx”", "example": "template-00000001" }, { "name": "ComplianceId", "type": "integer", "required": false, "description": "分类分级模板Id", "example": "1" }, { "name": "DiscoveryCondition", "type": "object", "required": false, "description": "敏感数据扫描数据源条件。", "example": "condition", "children": [ { "name": "RDBInstances", "type": "array", "required": false, "description": "RDB实例列表", "example": "[{\"DataSourceId\":\"cdb-a1b2\",\"DataSourceType\":\"cdb\",\"ResourceRegion\":\"ap-guangzhou\",\"DiscoveryTaskId\":1987,\"DBs\":[{\"DBName\":\"asset\",\"DBSchema\":\"default\"}]\"DiscoveryTaskInstanceID\":1321}]", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源Id", "example": "cbd-a1b2" }, { "name": "DataSourceType", "type": "string", "required": true, "description": "cdb, dcdb, mariadb, postgres, cynosdbpg, cynosdbmysql, cos, mysql_like_proto, postgre_like_proto", "example": "cdb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所在地域", "example": "ap-guangzhou" }, { "name": "DBs", "type": "array", "required": false, "description": "若未来扩展到DBName粒度，可采用", "example": "default", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": true, "description": "数据库名称", "example": "default" }, { "name": "DBSchema", "type": "string", "required": true, "description": "数据库Schema", "example": "schema" } ] } ] }, { "name": "COSInstances", "type": "array", "required": false, "description": "COS实例列表", "example": "[{\"DataSourceId\":\"cos-xadsa\",\"DataSourceType\":\"cos\",\"ResourceRegion\":\"ap-guangzhou\",\"DiscoveryTaskId\":1987,\"DiscoveryTaskInstanceID\":1321}]", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源Id", "example": "cos-cd514cb2baa46034bedae480c871f5b6a367e123" }, { "name": "BucketName", "type": "string", "required": true, "description": "桶名", "example": "bucket" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所在地域", "example": "ap-guangzhou" } ] }, { "name": "NOSQLInstances", "type": "array", "required": false, "description": "Mongo实例列表", "example": "[{\"DataSourceId\":\"mongodb-a1b2\",\"DataSourceType\":\"mongodb\",\"ResourceRegion\":\"ap-guangzhou\",\"DiscoveryTaskId\":1987,\"DiscoveryTaskInstanceID\":1321}]", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源id", "example": "mongodb-a1b2" }, { "name": "DataSourceType", "type": "string", "required": true, "description": "cdb, dcdb, mariadb, postgres, cynosdbpg, cynosdbmysql, cos, mysql_like_proto, postgre_like_proto,mongodb", "example": "mongodb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所在地域", "example": "ap-shanghai" }, { "name": "DiscoveryTaskId", "type": "integer", "required": false, "description": "根据实例创建的敏感数据识别扫描任务Id", "example": "1" }, { "name": "DiscoveryTaskInstanceID", "type": "integer", "required": false, "description": "敏感数据识别任务实例id", "example": "2" } ] }, { "name": "ESInstances", "type": "array", "required": false, "description": "ES实例列表", "example": "[{\"DataSourceId\":\"es-a1b2\",\"DataSourceType\":\"es\",\"ResourceRegion\":\"ap-guangzhou\",\"DiscoveryTaskId\":1987,\"DiscoveryTaskInstanceID\":1321}]", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源id", "example": "es-a1b2" }, { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "es" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "地域", "example": "ap-shanghai" }, { "name": "DiscoveryTaskId", "type": "integer", "required": false, "description": "扫描任务ID", "example": "1" }, { "name": "DiscoveryTaskInstanceID", "type": "integer", "required": false, "description": "扫描任务实例ID", "example": "1" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "说明", "example": "description" } ], "required": [ "DspaId", "Name", "TemplateId" ] }, { "name": "CreateDSPACOSDiscoveryTask", "description": "新增COS分类分级扫描任务，单个用户最多允许创建100个任务。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-98ad3j9a" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "分类分级任务" }, { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cos-23ics9a308usadi23e2ed" }, { "name": "Enable", "type": "integer", "required": true, "description": "任务开关，0 关闭，1 启用", "example": "1" }, { "name": "Bucket", "type": "string", "required": true, "description": "桶名", "example": "bucket_1" }, { "name": "Plan", "type": "integer", "required": true, "description": "执行计划， 0立即 1定时，选择“立即”时，扫描周期只能选择单次。", "example": "0" }, { "name": "Period", "type": "integer", "required": true, "description": "扫描周期，0单次 1每天 2每周 3每月", "example": "0" }, { "name": "FileTypes", "type": "array", "required": true, "description": "待扫描文件类型，用逗号隔开，格式如：[\".txt\", \".csv\", \".log\", \".xml\",\".html\", \".json\"]。", "example": ".txt, .csv", "item_type": "string" }, { "name": "FileSizeLimit", "type": "integer", "required": true, "description": "文件大小上限，单位为KB，如1000, 目前单个文件最大只支持100MB（102400KB）", "example": "1000" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所在地域", "example": "ap-guangzhou" }, { "name": "Description", "type": "string", "required": false, "description": "任务描述，最大长度为1024个字符", "example": "扫描任务" }, { "name": "GeneralRuleSetEnable", "type": "integer", "required": false, "description": "通用规则集开关，0 关闭，1 启用", "example": "1" }, { "name": "ComplianceGroupIds", "type": "array", "required": false, "description": "合规组ID列表，最多支持添加5个", "example": "[1,2]", "item_type": "integer" }, { "name": "TimingStartTime", "type": "string", "required": false, "description": "任务定时启动时间，格式如：2006-01-02 15:04:05 当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。", "example": "2022-01-02 15:04:05" } ], "required": [ "DspaId", "Name", "DataSourceId", "Enable", "Bucket", "Plan", "Period", "FileTypes", "FileSizeLimit", "ResourceRegion" ] }, { "name": "CreateDSPACategory", "description": "新增分类，单个用户最多允许创建100个数据分类。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "Name", "type": "string", "required": true, "description": "敏感数据分类名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "财务信息" } ], "required": [ "DspaId", "Name" ] }, { "name": "CreateDSPACategoryRelation", "description": "创建分类关联关系", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "分类id", "example": "1" }, { "name": "ParentCategoryId", "type": "integer", "required": true, "description": "父级分类id（无父级分类传-1）", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "分类模板id", "example": "1" } ], "required": [ "DspaId", "CategoryId", "ParentCategoryId", "ComplianceId" ] }, { "name": "CreateDSPAComplianceGroup", "description": "新增分类分级模板，单个用户最多允许创建100个合规组。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "Name", "type": "string", "required": true, "description": "合规组名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "测试合规组" }, { "name": "Description", "type": "string", "required": false, "description": "合规组描述，最大长度为1024个字符", "example": "自定义测试合规组" }, { "name": "ComplianceGroupRules", "type": "array", "required": false, "description": "合规组规则配置（参数已废弃，请传空数组）", "example": "[{\"RuleId\":2,\"CategoryId\":3,\"LevelId\":2}]", "item_type": "object", "children": [ { "name": "RuleId", "type": "integer", "required": true, "description": "敏感数据识别规则ID", "example": "1" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "敏感数据分类ID", "example": "1" }, { "name": "LevelId", "type": "integer", "required": true, "description": "敏感数据分级标识ID, 系统支持高、中、低三级，也支持自定义分级", "example": "1" } ] }, { "name": "LevelGroupId", "type": "integer", "required": false, "description": "分级组ID，默认值为1，新增参数，可选", "example": "1" }, { "name": "Status", "type": "integer", "required": false, "description": "1代表模板开启，0代表模板关闭", "example": "1" }, { "name": "CloseComplianceId", "type": "integer", "required": false, "description": "该complianceId的开启状态将被关闭", "example": "1" } ], "required": [ "DspaId", "Name" ] }, { "name": "CreateDSPAComplianceRules", "description": "创建合规组分类规则关联关系", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "分类id", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组模板id", "example": "1" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "example": "[{\"RuleId\":1,\"LevelId\":5}]", "item_type": "object", "children": [ { "name": "RuleId", "type": "integer", "required": true, "description": "规则id", "example": "1" }, { "name": "LevelId", "type": "integer", "required": true, "description": "级别id", "example": "1" } ] } ], "required": [ "DspaId", "CategoryId", "ComplianceId", "Rules" ] }, { "name": "CreateDSPACosMetaResources", "description": "添加COS元数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a2cf12de" }, { "name": "CosBucketItems", "type": "array", "required": true, "description": "必填，COS资源列表", "example": "cosItem", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "Buckets", "type": "array", "required": true, "description": "COS桶列表。", "example": "[bucket1]", "item_type": "string" } ] } ], "required": [ "DspaId", "CosBucketItems" ] }, { "name": "CreateDSPADbMetaResources", "description": "添加用户云上数据库类型资源", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-12345678" }, { "name": "MetaType", "type": "string", "required": true, "description": "资源类型，支持：cdb（云数据库 MySQL）、dcdb（TDSQL MySQL版）、mariadb（云数据库 MariaDB）、postgres（云数据库 PostgreSQL）、cynosdbpg（TDSQL-C PostgreSQL版）、cynosdbmysql（TDSQL-C MySQL版）", "example": "cdb" }, { "name": "CloudResourceItems", "type": "array", "required": true, "description": "必填，云数据库资源列表。", "example": "[cloudResourceItem]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou\t" }, { "name": "Items", "type": "array", "required": true, "description": "云上资源列表。", "example": "[{\"ResourceId\":\"cdb-c1b2\",\"ResourceName\":\"cdb-c1b2\",\"ResourceVip\":\"192.168.190.1\",\"ResourceVPort\":3306,\"ResourceCreateTime\":\"2024-09-13\",\"ResourceUniqueVpcId\":\"vpc-c3b4\",\"ResourceUniqueSubnetId\":\"subnet-a6f8\"}]", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "用户资源ID。", "example": "cdb-c1b2" }, { "name": "ResourceName", "type": "string", "required": true, "description": "资源名称。", "example": "cdb-name" }, { "name": "ResourceVip", "type": "string", "required": true, "description": "资源VIP。", "example": "127.0.0.1" }, { "name": "ResourceVPort", "type": "integer", "required": true, "description": "资源端口。", "example": "3306" }, { "name": "ResourceCreateTime", "type": "string", "required": true, "description": "资源被创建时间。", "example": "2024-09-13" }, { "name": "ResourceUniqueVpcId", "type": "string", "required": true, "description": "用户资源VPC ID 字符串。", "example": "vpc-c3b4" }, { "name": "ResourceUniqueSubnetId", "type": "string", "required": true, "description": "用户资源Subnet ID 字符串。", "example": "subnet-a6f8" } ] } ] } ], "required": [ "DspaId", "MetaType", "CloudResourceItems" ] }, { "name": "CreateDSPADiscoveryRule", "description": "新增分类分级规则，单个用户最多允许创建200个规则。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "Name", "type": "string", "required": true, "description": "规则名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "姓名" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度为1024个字符", "example": "该规则用于匹配姓名" }, { "name": "RDBRules", "type": "object", "required": false, "description": "RDB类敏感数据识别规则", "example": "{ \"Status\": 0, \"MatchOperator\": \"or\", \"MetaRule\": { \"Operator\": \"and\", \"Contents\": [ { \"RuleType\": \"keyword\", \"RuleContent\": \"账户\", \"ExtendParameters\": [ { \"Name\": \"IsFullWordMatch\", \"Value\": \"false\" }, { \"Name\": \"IsIgnoreCase\", \"Value\": \"true\" } ] }, { \"RuleType\": \"keyword\", \"RuleContent\": \"余额\", \"ExtendParameters\": [ { \"Name\": \"IsFullWordMatch\", \"Value\": \"false\" }, { \"Name\": \"IsIgnoreCase\", \"Value\": \"true\" } ] } ] }, \"ContentRule\": { \"Operator\": \"or\", \"Contents\": [ { \"RuleType\": \"regex\", \"RuleContent\": \"正则的具体规则\", } ] } }", "children": [ { "name": "Status", "type": "integer", "required": true, "description": "规则状态；0 不启用, 1 启用", "example": "1" }, { "name": "MatchOperator", "type": "string", "required": true, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一", "example": "and" }, { "name": "MetaRule", "type": "object", "required": true, "description": "字段名包含规则，最大支持选择9项", "example": "{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "操作符；只能取and, or的其中一种", "example": "and" }, { "name": "Contents", "type": "array", "required": true, "description": "规则", "example": "[{\"RuleType\":\"keyword\",\"RuleContent\":\"keyword\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]}]", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型；取值： keyword 关键字, regex 正则", "example": "keyword" }, { "name": "RuleContent", "type": "string", "required": true, "description": "内容", "example": "phone" }, { "name": "ExtendParameters", "type": "array", "required": false, "description": "该字段是针对规则类型RuleType为keyword类型时的一个扩展属性", "example": "[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]", "item_type": "string" } ] } ] }, { "name": "ContentRule", "type": "object", "required": true, "description": "内容包含规则，最大支持选择9项", "example": "{ \"Operator\":\"or\", \"Contents\":[{\"RuleType\":\"regex\",\"RuleContent\":\"^[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)+(com|cn|net|pk|om|it|za|nz|sg|ae|fm|sy|org|tr|ye|cy|gr|in|ru|de|il|au|vn|jp|zm|ar|mk|gn|mx|es|fr|zw|ci|na|np|to|id|ie|sa|mn|uk|se|at)$\"}]}", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "操作符；只能取and, or的其中一种", "example": "and" }, { "name": "Contents", "type": "array", "required": true, "description": "规则", "example": "[{\"RuleType\":\"keyword\",\"RuleContent\":\"keyword\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]}]", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型；取值： keyword 关键字, regex 正则", "example": "keyword" }, { "name": "RuleContent", "type": "string", "required": true, "description": "内容", "example": "phone" }, { "name": "ExtendParameters", "type": "array", "required": false, "description": "该字段是针对规则类型RuleType为keyword类型时的一个扩展属性", "example": "[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]", "item_type": "string" } ] } ] } ] }, { "name": "COSRules", "type": "object", "required": false, "description": "COS类敏感数据识别规则", "example": "{ \"RegexRule\": { \"Operator\": \"or\", \"Contents\": [ { \"RuleContent\": \"正则规则\", \"IsIgnoreCase\": true } ] }, \"KeywordRule\": { \"Operator\": \"or\", \"Contents\": [ { \"RuleContent\": \"账户余额\", \"IsIgnoreCase\": true } ] }, \"MaxMatch\": 100 }", "children": [ { "name": "Status", "type": "integer", "required": false, "description": "规则状态；0 不启用, 1 启用", "example": "1" }, { "name": "RegexRule", "type": "object", "required": false, "description": "regex规则内容", "example": "and", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"keyword\",\"IsIgnoreCase\":true}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": false, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "KeywordRule", "type": "object", "required": false, "description": "关键词规则内容组，最大支持5个关键词。", "example": "{\"Operator\":\"and\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"keyword\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"keyword\",\"IsIgnoreCase\":true}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": false, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "IgnoreStringRule", "type": "object", "required": false, "description": "忽略词规则内容组，最大支持5个忽略词。", "example": "{\"Operator\":\"and\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"keyword\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"keyword\",\"IsIgnoreCase\":true}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": false, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "MaxMatch", "type": "integer", "required": false, "description": "最大匹配距离，默认值为100。上限为500.", "example": "100" } ] }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态；0 不启用, 1 启用", "example": "1" } ], "required": [ "DspaId", "Name" ] }, { "name": "CreateDSPADiscoveryTask", "description": "新增分类分级任务，单个用户最多允许创建100个任务。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-89asd23" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "分类分级任务" }, { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-as9dh932" }, { "name": "Enable", "type": "integer", "required": true, "description": "任务开关，0 关闭，1 启用", "example": "1" }, { "name": "Plan", "type": "integer", "required": true, "description": "执行计划， 0立即 1定时，选择“立即”时，扫描周期只能选择单次", "example": "0" }, { "name": "Period", "type": "integer", "required": true, "description": "扫描周期，0单次 1每天 2每周 3每月", "example": "0" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所在地域", "example": "ap-guangzhou" }, { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型，可取值如下： cdb 表示云数据库 MySQL, dcdb 表示TDSQL MySQL版, mariadb 表示云数据库 MariaDB, postgres 表示云数据库 PostgreSQL, cynosdbpg 表示TDSQL-C PostgreSQL版, cynosdbmysql 表示TDSQL-C MySQL版, selfbuilt-db 表示自建数据库", "example": "cdb" }, { "name": "Description", "type": "string", "required": false, "description": "任务描述，最大长度为1024个字符", "example": "扫描任务" }, { "name": "Condition", "type": "string", "required": false, "description": "用于传入的数据源的条件，目前只支持数据库，所以目前表示数据库的名称，选择多个数据库，之间通过逗号分隔，若不选，则默认选择全部数据库", "example": "db_1,db_2" }, { "name": "ComplianceGroupIds", "type": "array", "required": false, "description": "此参数必选。合规组ID列表，最多支持添加5个", "example": "[1,2]", "item_type": "integer" }, { "name": "TimingStartTime", "type": "string", "required": false, "description": "任务定时启动时间，格式如：2006-01-02 15:04:05 当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。", "example": "2022-01-02 15:04:05" }, { "name": "Order", "type": "string", "required": false, "description": "random-随机，asc生序，desc降序", "example": "抽样方式" }, { "name": "Rows", "type": "integer", "required": false, "description": "抽样的条数，范围30-1000", "example": "20" }, { "name": "GlobalOrderField", "type": "string", "required": false, "description": "抽样的排序字段", "example": "id" }, { "name": "ScanRange", "type": "string", "required": false, "description": "full:全量扫描 incre:变更扫描", "example": "full" } ], "required": [ "DspaId", "Name", "DataSourceId", "Enable", "Plan", "Period", "ResourceRegion", "DataSourceType" ] }, { "name": "CreateDSPALevelGroup", "description": "新增分级，单个Casb实例最多允许创建100个数据分级", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "Name", "type": "string", "required": true, "description": "分级组名称，唯一性约束，最多60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "系统-高中低" }, { "name": "ItemLevels", "type": "array", "required": true, "description": "分级标识配置", "example": "[ { \"LevelRiskName\":\"高\", \"LevelRiskScore\":10 }, { \"LevelRiskName\":\"中\", \"LevelRiskScore\":5 }, { \"LevelRiskName\":\"低\", \"LevelRiskScore\":1 } ]", "item_type": "object", "children": [ { "name": "LevelRiskName", "type": "string", "required": true, "description": "分级标识名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "高" }, { "name": "LevelRiskScore", "type": "integer", "required": true, "description": "分级标识对应的风险分数值，1-10，最小为1，最大为10", "example": "10" } ] }, { "name": "Description", "type": "string", "required": false, "description": "分级组描述，最多1024字符", "example": "系统默认分级组" } ], "required": [ "DspaId", "Name", "ItemLevels" ] }, { "name": "CreateDSPAMetaResources", "description": "添加用户云上资源列表", "status": "online", "parameters": [ { "name": "MetaType", "type": "string", "required": true, "description": "资源类型，支持：cdb（云数据库 MySQL）、dcdb（TDSQL MySQL版）、mariadb（云数据库 MariaDB）、postgres（云数据库 PostgreSQL）、cynosdbpg（TDSQL-C PostgreSQL版）、cynosdbmysql（TDSQL-C MySQL版）", "example": "cdb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-12cd45g7" }, { "name": "UpdateStatus", "type": "string", "required": true, "description": "用来标记本次更新是否已经是最后一次，可选值：continue（后续还需要更新）、finished（本次是最后一次更新）。", "example": "continue" }, { "name": "UpdateId", "type": "string", "required": true, "description": "本次更新的ID号，用来标记一次完整的更新过程。", "example": "1" }, { "name": "Items", "type": "array", "required": true, "description": "资源列表。", "example": "[item1,itme2]", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "用户资源ID。", "example": "1321" }, { "name": "ResourceName", "type": "string", "required": true, "description": "资源名称。", "example": "cos-absf2" }, { "name": "ResourceVip", "type": "string", "required": true, "description": "资源VIP。", "example": "127.0.0.2" }, { "name": "ResourceVPort", "type": "integer", "required": true, "description": "资源端口。", "example": "7890" }, { "name": "ResourceCreateTime", "type": "string", "required": true, "description": "资源被创建时间。", "example": "2024-01-02" }, { "name": "ResourceUniqueVpcId", "type": "string", "required": true, "description": "用户资源VPC ID 字符串。", "example": "3131" }, { "name": "ResourceUniqueSubnetId", "type": "string", "required": true, "description": "用户资源Subnet ID 字符串。", "example": "32141" }, { "name": "MetaType", "type": "string", "required": false, "description": "用户资源类型信息。", "example": "mysql" }, { "name": "ResourceRegion", "type": "string", "required": false, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "ResourceSyncTime", "type": "string", "required": false, "description": "资源被同步时间。", "example": "2024-02-04" }, { "name": "AuthStatus", "type": "string", "required": false, "description": "资源被授权状态。", "example": "success" }, { "name": "BuildType", "type": "string", "required": false, "description": "资源创建类型，cloud-云原生资源，build-用户自建资源。", "example": "cloud" }, { "name": "MasterInsId", "type": "string", "required": false, "description": "主实例ID。", "example": "12321" }, { "name": "ResourceVpcId", "type": "integer", "required": false, "description": "用户资源VPC ID 整数。", "example": "3213" }, { "name": "ResourceSubnetId", "type": "integer", "required": false, "description": "用户资源Subnet ID 整数。", "example": "2313" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议类型。", "example": "mysql" }, { "name": "ResourceVersion", "type": "string", "required": false, "description": "资源版本号。", "example": "1" }, { "name": "ResourceAuthType", "type": "string", "required": false, "description": "授权方式", "example": "automatic" }, { "name": "ResourceAuthAccount", "type": "string", "required": false, "description": "授权账号名", "example": "admin" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型", "example": "type" }, { "name": "InstanceValue", "type": "string", "required": false, "description": "实例值", "example": "value" }, { "name": "GovernAuthStatus", "type": "integer", "required": false, "description": "//治理授权状态（0：关闭 1：开启）", "example": "0" }, { "name": "AuthRange", "type": "string", "required": false, "description": "授权范围：all - 授权整个数据源 manual:手动指定数据源", "example": "all" } ] } ], "required": [ "MetaType", "ResourceRegion", "DspaId", "UpdateStatus", "UpdateId", "Items" ] }, { "name": "CreateDSPASelfBuildMetaResource", "description": "新建用户自建云资源", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "Dspa实例ID。", "example": "dspa-a1b2c3" }, { "name": "MetaType", "type": "string", "required": true, "description": "自建数据库类型。目前支持的自建数据库类型按照协议进行区分，支持两种开源数据库协议： mysql_like_proto -- Mysql协议类关系型数据库， postgre_like_proto -- Postgre协议类关系型数据库。 其他闭源协议的数据库如SqlServer、Oracle等暂不支持。", "example": "cdb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "ResourceId", "type": "string", "required": true, "description": "自建云资源ID。", "example": "cdb-a1b2" }, { "name": "ResourceUniqueVpcId", "type": "string", "required": true, "description": "自建云资源的VPC ID。", "example": "127.31.41.43" }, { "name": "ResourceUniqueSubnetId", "type": "string", "required": true, "description": "自建云资源的Subnet ID。", "example": "4214" }, { "name": "ResourceAccessType", "type": "string", "required": true, "description": "自建云资源所处的服务类型，可选： cvm - 通过云服务器直接访问。 clb - 通过LB的方式进行访问。", "example": "cvm" }, { "name": "ResourceVip", "type": "string", "required": true, "description": "可用于访问自建云资源的IP。 emr的连接不需要使用该字段", "example": "127.31.41.42" }, { "name": "ResourceVPort", "type": "integer", "required": true, "description": "可用于访问自建云资源的端口。 emr的连接不需要使用该字段", "example": "2203" }, { "name": "UserName", "type": "string", "required": true, "description": "账户名。如果emr_hive的连接方式为“LDAP”，则复用该字段", "example": "admin" }, { "name": "Password", "type": "string", "required": true, "description": "账户密码。如果emr_hive的连接方式为“LDAP”，则复用该字段", "example": "password" }, { "name": "ResourceName", "type": "string", "required": false, "description": "资源名称，1-60个字符。", "example": "cdb-11am" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型 databse sid serviceName", "example": "database" }, { "name": "InstanceValue", "type": "string", "required": false, "description": "实例值", "example": "database" }, { "name": "AuthRange", "type": "string", "required": false, "description": "授权范围（all:授权整个数据源 manual:手动指定数据库）", "example": "all" } ], "required": [ "DspaId", "MetaType", "ResourceRegion", "ResourceId", "ResourceUniqueVpcId", "ResourceUniqueSubnetId", "ResourceAccessType", "ResourceVip", "ResourceVPort", "UserName", "Password" ] }, { "name": "CreateIdentifyRuleAnotherName", "description": "创建规则别名", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-abcd1234" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "规则绑定的分类id", "example": "1" }, { "name": "RuleId", "type": "integer", "required": true, "description": "规则id", "example": "1" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "手机号" }, { "name": "AnotherName", "type": "string", "required": true, "description": "规则别名", "example": "电话号码" }, { "name": "AliasRuleId", "type": "integer", "required": false, "description": "别名规则id", "example": "1" }, { "name": "AliasRuleName", "type": "string", "required": false, "description": "别名规则名称", "example": "rulename" } ], "required": [ "DspaId", "ComplianceId", "CategoryId", "RuleId", "RuleName", "AnotherName" ] }, { "name": "DecribeSuggestRiskLevelMatrix", "description": "风险等级的定义页面-创建风险等级的时候生成的一个默认的矩阵", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspaId", "example": "dspa-fx2dcs3v" }, { "name": "SensitiveLevelList", "type": "array", "required": true, "description": "分类分级等级列表", "example": "[{ \"Id\": 8, \"Name\": \"敏感\", \"Score\": 10 }, { \"Id\": 9, \"Name\": \"重要\", \"Score\": 5 }, { \"Id\": 10, \"Name\": \"一般\", \"Score\": 1 }, { \"Id\": 0, \"Name\": \"NotSensitive\", \"Score\": 0 }]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "risk-name" }, { "name": "Id", "type": "integer", "required": false, "description": "就是id", "example": "1" }, { "name": "Score", "type": "float", "required": false, "description": "分数", "example": "10" } ] }, { "name": "VulnerabilityLevelList", "type": "array", "required": true, "description": "脆弱项等级列表", "example": "[{ \"Name\": \"high\", \"Score\": 10, \"Id\": 1 }, { \"Name\": \"medium\", \"Score\": 5, \"Id\": 2 }, { \"Name\": \"low\", \"Score\": 1, \"Id\": 3 }]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "risk-name" }, { "name": "Id", "type": "integer", "required": false, "description": "就是id", "example": "1" }, { "name": "Score", "type": "float", "required": false, "description": "分数", "example": "10" } ] } ], "required": [ "DspaId", "SensitiveLevelList", "VulnerabilityLevelList" ] }, { "name": "DeleteCosMetaResource", "description": "本接口（DeleteCOSMetaData）用于删除COS元数据信息。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "实例Id。", "example": "dspa-0000000" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "ResourceIds", "type": "array", "required": false, "description": "资源实例ID。", "example": "[\"cdb-78acde\",\"mariadb-123faed1\"]", "item_type": "string" } ], "required": [ "DspaId", "ResourceRegion" ] }, { "name": "DeleteDSPAAssessmentTask", "description": "删除DSPA风险评估任务", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "TaskId", "type": "string", "required": true, "description": "评估任务Id，格式“task-xxxxxxxx”", "example": "task-xxxxxxxx" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DeleteDSPACOSDiscoveryTask", "description": "删除COS分类分级任务，该接口只有在任务状态为以下几个状态值时才支持正确删除： 0 待扫描， 2 扫描终止， 3 扫描成功， 4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DeleteDSPACOSDiscoveryTaskResult", "description": "删除COS分类分级任务结果", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "BucketResultId", "type": "integer", "required": true, "description": "扫描bucket结果ID", "example": "1" } ], "required": [ "DspaId", "BucketResultId" ] }, { "name": "DeleteDSPADiscoveryTask", "description": "删除分类分级识别任务，该接口只有在任务状态为以下几个状态值时才支持正确删除： 0 待扫描， 2 扫描终止， 3 扫描成功， 4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "DataSourceType", "type": "string", "required": false, "description": "数据源类型", "example": "es" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DeleteDSPADiscoveryTaskResult", "description": "删除分类分级识别任务结果", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "DbResultId", "type": "integer", "required": true, "description": "扫描数据库结果ID", "example": "1" } ], "required": [ "DspaId", "DbResultId" ] }, { "name": "DeleteDSPAMetaResource", "description": "删除用户云资源", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2" }, { "name": "ResourceIDs", "type": "array", "required": true, "description": "用户云资源ID。", "example": "[9781,3213]", "item_type": "string" } ], "required": [ "DspaId", "ResourceIDs" ] }, { "name": "DescribeAssetDetailDataExportResult", "description": "查询敏感数据导出结果URL", "status": "online", "parameters": [ { "name": "ExportTaskId", "type": "integer", "required": true, "description": "导出任务id", "example": "1" }, { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "1" } ], "required": [ "ExportTaskId", "DspaId" ] }, { "name": "DescribeAssetOverview", "description": "数据资产报告页面-查询数据资产概览接口（包括数据库资产详情和存储资产详情）", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-44b7bd87" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "12" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产信息列表", "example": "[ { \"DataSourceType\": \"cdb\", \"DataSourceInfo\": [ { \"DataSourceId\": \"cdb-14nmkefc\", \"BindList\": [ \"verify_db\" ] } ] } ]", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DescribeBindDBList", "description": "查询DB绑定的列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" } ], "required": [ "DspaId" ] }, { "name": "DescribeCOSAssetSensitiveDistribution", "description": "数据资产报告-查询cos的资产分布详情接口", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产列表", "example": "[{\"DataSourceType\":\"cdb\",\"DataSourceInfo\":[{\"DataSourceId\":\"cdb-b1c2d3\",\"BindList\":[\"asset\"]}]}]", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DescribeDSPAAssessmentHighRiskTop10Overview", "description": "查询高风险资产的top10", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例Id", "example": "dspa-xxx" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "1" }, { "name": "Filter", "type": "string", "required": false, "description": "过滤条件， rdb（数据库）cos（对象存储） 不传就是全部", "example": "rdb，cos" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentLatestRiskDetailInfo", "description": "查询最新风险项详情数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例Id", "example": "dspa-a1b2c3d4" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "1" }, { "name": "RiskId", "type": "integer", "required": true, "description": "风险id", "example": "1" } ], "required": [ "DspaId", "TemplateId", "RiskId" ] }, { "name": "DescribeDSPAAssessmentLatestRiskList", "description": "查询最新的风险详情列表数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例Id", "example": "dspa-abc213" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数", "example": "10" }, { "name": "Offset", "type": "string", "required": false, "description": "分页偏移量", "example": "10" }, { "name": "DataSourceId", "type": "string", "required": false, "description": "资产名称，数据源id", "example": "cos-adav1" }, { "name": "RiskType", "type": "string", "required": false, "description": "风险类型", "example": "config-risk" }, { "name": "ControlItemId", "type": "string", "required": false, "description": "风险项", "example": "AKSK泄漏" }, { "name": "Status", "type": "integer", "required": false, "description": "风险状态", "example": "新发现" }, { "name": "BeginTime", "type": "string", "required": false, "description": "扫描开始时间", "example": "2020/01/05" }, { "name": "EndTime", "type": "string", "required": false, "description": "扫描结束时间", "example": "2020/01/05" }, { "name": "RiskLevel", "type": "string", "required": false, "description": "风险等级筛选", "example": "高" }, { "name": "RiskSide", "type": "array", "required": false, "description": "风险面筛选", "example": "riskside", "item_type": "string" }, { "name": "TimeSort", "type": "string", "required": false, "description": "ASC 正序，DESC倒叙", "example": "ASC" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentNewDiscoveredRiskOverview", "description": "风险概览-查询新发现风险统计数", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a2b3ed12" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "12" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentPendingRiskOverview", "description": "风险概览-查询待处理风险统计数", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "12" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentProcessingRiskOverview", "description": "风险概览-查询处理中风险统计数", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "12" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentRiskAmountOverview", "description": "风险概览页风险数量和受影响资产数概览统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "12" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentRiskDatasourceTop5", "description": "受影响资产TOP5统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPAAssessmentRiskDealedOverview", "description": "遗留待处理\u0026昨日完成风险处置概览统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPAAssessmentRiskDealedTrend", "description": "风险项处理趋势统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始日期", "example": "2022-09-10" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束日期", "example": "2022-09-10" }, { "name": "TemplateId", "type": "string", "required": false, "description": "评估模板id", "example": "2" } ], "required": [ "DspaId", "StartTime", "EndTime" ] }, { "name": "DescribeDSPAAssessmentRiskDistributionOverview", "description": "查询风险分布数据，包含风险类型分布，风险详情分布，风险资产的分布", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例Id", "example": "dspa-xxx" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "1" }, { "name": "Filter", "type": "string", "required": false, "description": "风险资产分布的过滤条件 （rdb，cos，不传就筛选全部）", "example": "rdb，cos" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentRiskItemTop5", "description": "风险分类TOP5统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPAAssessmentRiskLevelDetail", "description": "风险项页面----查询风险等级的详情数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "RiskLevelId", "type": "integer", "required": true, "description": "风险级别id", "example": "1" } ], "required": [ "DspaId", "RiskLevelId" ] }, { "name": "DescribeDSPAAssessmentRiskLevelList", "description": "风险项页面----查询风险等级的列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" } ], "required": [ "DspaId", "Limit", "Offset" ] }, { "name": "DescribeDSPAAssessmentRiskLevelTrend", "description": "风险级别趋势统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始日期", "example": "2022-09-10" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时日期", "example": "2022-09-10" }, { "name": "TemplateId", "type": "string", "required": false, "description": "评估模板id", "example": "2" } ], "required": [ "DspaId", "StartTime", "EndTime" ] }, { "name": "DescribeDSPAAssessmentRiskOverview", "description": "风险数量概览统计", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPAAssessmentRiskProcessHistory", "description": "查询风险的处理历史", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" }, { "name": "RiskId", "type": "integer", "required": true, "description": "风险id", "example": "1" } ], "required": [ "DspaId", "RiskId" ] }, { "name": "DescribeDSPAAssessmentRiskSideDistributed", "description": "风险评估概览页，查询风险面的分布", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-a1b2c3" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "1" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentRiskSideList", "description": "风险评估概览页，查询风险面的分布", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-a1b2c3" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "评估模板id", "example": "1" } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentRiskTemplateDetail", "description": "风险项页面--查看评估模板详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板id", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" } ], "required": [ "DspaId", "TemplateId", "Limit", "Offset" ] }, { "name": "DescribeDSPAAssessmentRiskTemplateVulnerableList", "description": "风险模板页面--查询风险模板中的脆弱项配置", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "RiskType", "type": "string", "required": false, "description": "风险类型", "example": "account_type" }, { "name": "RiskName", "type": "string", "required": false, "description": "风险名称", "example": "数据库未审计" }, { "name": "RiskSide", "type": "string", "required": false, "description": "风险面", "example": "riskSide" } ], "required": [ "DspaId", "Limit", "Offset" ] }, { "name": "DescribeDSPAAssessmentRisks", "description": "获取DSPA评估风险项列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "TaskId", "type": "string", "required": true, "description": "评估任务Id，格式“task-xxxxxxxx”", "example": "task-13ce2" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "结果集个数限制。默认为20，最大值为100", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤项。 支持模糊搜索：ControlItemName。 支持过滤： RiskLevel：风险等级（high，medium，low） Status：风险处理状态(waiting待处理, processing处理中, stopped处理暂停, finished已处理, failed处理失败)", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DescribeDSPAAssessmentTasks", "description": "获取DSPA评估任务列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "结果集个数限制。默认为20，最大值为100", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤项。支持模糊搜索：TaskId，TaskName支持过滤：BusinessName：业务名称BusinessDept：业务部门名称TemplateName：评估模板名称Status：评估状态 (waiting待评估，processing评估中, , finished已评估, failed评估失败)", "example": "[{\"Name\":\"AssessmentId\",\"Values\":[\"1\",\"2\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPAAssessmentTemplateControlItems", "description": "获取DSPA评估模板关联的评估控制项列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id。格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "TemplateId", "type": "string", "required": true, "description": "评估模板Id。格式“template-xxxxxxxx”", "example": "template-asset_info" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "结果集个数限制。默认为20，最大值为100", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤项。 支持模糊搜索：ItemId，ItemName 支持过滤： Source：评估项来源，system / user ItemType：评估项类型，questionnaire / auto ItemSubType：评估项子类型 Status：评估项启用状态，draft / launched", "example": "[{\"Name\":\"AssessmentId\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] } ], "required": [ "DspaId", "TemplateId" ] }, { "name": "DescribeDSPAAssessmentTemplates", "description": "获取DSPA评估模板列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "结果集个数限制。默认为20，最大值为100", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤项。支持模糊搜索：（TemplateId，TemplateName）支持过滤：Source：模板来源，system / userUseType：模板类型，auto，semi-auto，law等Status：模板启用状态，draft / launched，ComplianceId：关联的分类分级模板id", "example": "[{\"Name\":\"cdb\",\"Values\":[\"cdb-a1b2\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPACOSDataAssetBuckets", "description": "获取COS敏感数据资产桶列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id", "example": "dspa-001" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组Id", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPACOSDataAssetByComplianceId", "description": "获取COS单个模板下的敏感数据资产", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPACOSDataAssetDetail", "description": "获取COS分类分级数据资产详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-ab50f3b1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPACOSDiscoveryTaskDetail", "description": "获取COS分类分级任务详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DescribeDSPACOSDiscoveryTaskFiles", "description": "获取COS分类分级任务结果详情文件列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id", "example": "dspa-ab50f3b1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "扫描任务ID", "example": "1" }, { "name": "ScanResultId", "type": "integer", "required": false, "description": "扫描结果id", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DescribeDSPACOSDiscoveryTaskResult", "description": "获取COS分类分级任务结果，该接口只有在任务状态为以下状态时才支持结果正常查询： 3 扫描成功， 4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值为20，最大值为100", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "Array of Filter 此参数对外不可见。过滤数组。支持的Name： BucketName 对象桶名 TaskID 任务ID， TaskName 任务名， DataSourceId：数据源ID， ResourceRegion：资源所在地域 每项过滤条件最多支持5个。", "example": "[ { \"Name\": \"DataSourceId\", \"Values\": [ \"cos-1bhjsad71h2eb21j2134b1jh\" ] } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"cdb\",\"mariadb\"]", "item_type": "string" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2025-05-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2025-05-01 13:00:00" }, { "name": "FetchHistory", "type": "boolean", "required": false, "description": "是否查询历史结果", "example": "true" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPACOSDiscoveryTasks", "description": "获取COS分类分级任务列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-1f96daa1" }, { "name": "TaskId", "type": "integer", "required": false, "description": "任务ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "任务名称", "example": "扫描敏感数据任务" }, { "name": "StatusList", "type": "array", "required": false, "description": "任务扫描结果状态，可供选择的状态值有：-1待触发 0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败", "example": "[1,2]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回结果集数量，默认值是10000，最大值为10000，根据该资源的个数限制条件，该资源的个数不会超过10000，所以如果不输入该字段，默认获取全量数据", "example": "20" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPACOSTaskResultDetail", "description": "获取COS分类分级任务结果详情，该接口只有在任务状态为时才支持结果正确查询： 3 扫描成功", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-78289ad1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名", "example": "file_1.txt" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "敏感数据分类ID", "example": "1" }, { "name": "LevelId", "type": "integer", "required": false, "description": "敏感数据分级ID", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值为20，最大值为100", "example": "10" }, { "name": "BucketName", "type": "string", "required": false, "description": "扫描桶名称。", "example": "bucket_1" }, { "name": "CategoryIdList", "type": "array", "required": false, "description": "多级分类的分类ID集合", "example": "[1]", "item_type": "integer" }, { "name": "ScanResultId", "type": "integer", "required": false, "description": "扫描结果id", "example": "1" } ], "required": [ "DspaId", "TaskId", "ComplianceId" ] }, { "name": "DescribeDSPACategories", "description": "获取敏感数据分类列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "数据分类ID", "example": "10000" }, { "name": "Name", "type": "string", "required": false, "description": "敏感数据分类名称", "example": "财务信息" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回结果集数量，默认值是10000，最大值为10000，根据该资源的个数限制条件，该资源的个数不会超过10000，所以如果不输入该字段，默认获取全量数据", "example": "1" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPACategoryRuleStatistic", "description": "获取分类规则统计信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组模板id", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPACategoryRules", "description": "获取合规组分类规则信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "分类id", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组模板id", "example": "1" } ], "required": [ "DspaId", "CategoryId", "ComplianceId" ] }, { "name": "DescribeDSPACategoryTree", "description": "获取分类树信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPACategoryTreeWithRules", "description": "获取分类规则树信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组模板id", "example": "1" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "分类id", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPAComplianceGroupDetail", "description": "获取模板详情信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "模板id", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPAComplianceGroups", "description": "获取分类分级模板列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-89asd34a" }, { "name": "ComplianceGroupId", "type": "integer", "required": false, "description": "合规组ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "合规组名称", "example": "电商分类分级模板" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回结果集数量，默认值是10000，最大值为10000，根据该资源的个数限制条件，该资源的个数不会超过10000，所以如果不输入该字段，默认获取全量数据", "example": "1" }, { "name": "ComplianceGroupTypeList", "type": "array", "required": false, "description": "合规组类型可选值：0 默认合规组, 1 系统合规组, 2 自定义合规组", "example": "[0,1]", "item_type": "integer" }, { "name": "IsFilterCloseComplianceGroup", "type": "boolean", "required": false, "description": "是否仅显示已开启模板", "example": "false" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPAComplianceUpdateNotification", "description": "获取模板更新提示信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组分类模板id", "example": "1" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPADataSourceDbInfo", "description": "获取数据源的数据库信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-6cmpe42v" }, { "name": "DataSourceType", "type": "string", "required": false, "description": "数据源类型", "example": "mysql" } ], "required": [ "DspaId", "DataSourceId" ] }, { "name": "DescribeDSPADiscoveryRules", "description": "获取分类分级规则列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回上限，默认值10， 最大值10000。", "example": "10" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "规则名称", "example": "测试规则" }, { "name": "FilterRuleSource", "type": "boolean", "required": false, "description": "是否需要过滤别名", "example": "false" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPADiscoveryServiceStatus", "description": "用于查询该用户是否已开通分类分级服务", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-test" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPADiscoveryTaskDetail", "description": "获取分类分级任务详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DescribeDSPADiscoveryTaskResult", "description": "获取分类分级任务结果，该接口只有在任务状态为以下状态时才支持结果正常查询：3 扫描成功，4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-89asd23f" }, { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型，可取值如下： cdb 表示云数据库 MySQL, dcdb 表示TDSQL MySQL版, mariadb 表示云数据库 MariaDB, postgres 表示云数据库 PostgreSQL, cynosdbpg 表示TDSQL-C PostgreSQL版, cynosdbmysql 表示TDSQL-C MySQL版, selfbuilt-db 表示自建数据库", "example": "cdb" }, { "name": "TaskId", "type": "integer", "required": false, "description": "任务ID", "example": "1" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称", "example": "扫描任务" }, { "name": "DataSourceId", "type": "string", "required": false, "description": "数据源ID", "example": "cdb-a80sd23a" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值为20，最大值为100", "example": "10" }, { "name": "ResourceRegion", "type": "string", "required": false, "description": "资源所在地域", "example": "ap-guangzhou" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2025-05-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2025-05-01 13:00:00" }, { "name": "FetchHistory", "type": "boolean", "required": false, "description": "是否查询历史结果", "example": "true" } ], "required": [ "DspaId", "DataSourceType" ] }, { "name": "DescribeDSPADiscoveryTaskResultDetail", "description": "获取分类分级任务结果详情，该接口只有在任务状态为时才支持结果正确查询： 3 扫描成功", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-98ahs23n " }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "DbResultId", "type": "integer", "required": true, "description": "扫描数据库结果ID", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "TableName", "type": "string", "required": false, "description": "所属数据表名", "example": "table1" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "敏感数据分类ID", "example": "1" }, { "name": "LevelId", "type": "integer", "required": false, "description": "敏感数据分级ID", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值为20，最大值为100", "example": "1" }, { "name": "CategoryIdList", "type": "array", "required": false, "description": "多级分类的分类ID集合", "example": "[1]", "item_type": "integer" }, { "name": "ScanResultId", "type": "integer", "required": false, "description": "任务扫描id", "example": "1" } ], "required": [ "DspaId", "TaskId", "DbResultId", "ComplianceId", "DbName" ] }, { "name": "DescribeDSPADiscoveryTaskTables", "description": "获取分级分级扫描的表集合", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-98ad232v" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "10" }, { "name": "DbName", "type": "string", "required": false, "description": "db名称", "example": "dbname1" }, { "name": "ScanResultId", "type": "integer", "required": false, "description": "任务扫描id", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "DescribeDSPADiscoveryTasks", "description": "获取分类分级任务列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型，可取值如下： cdb 表示云数据库 MySQL, dcdb 表示TDSQL MySQL版, mariadb 表示云数据库 MariaDB, postgres 表示云数据库 PostgreSQL, cynosdbpg 表示TDSQL-C PostgreSQL版, cynosdbmysql 表示TDSQL-C MySQL版, selfbuilt-db 表示自建数据库", "example": "cdb" }, { "name": "TaskId", "type": "integer", "required": false, "description": "任务ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "任务名称", "example": "扫描敏感数据任务" }, { "name": "StatusList", "type": "array", "required": false, "description": "任务扫描结果状态，可供选择的状态值有：-1待触发 0待扫描 1扫描中 2扫描终止 3扫描成功 4扫描失败", "example": "[1,2]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回结果集数量，默认值是10000，最大值为10000，根据该资源的个数限制条件，该资源的个数不会超过10000，所以如果不输入该字段，默认获取全量数据", "example": "20" } ], "required": [ "DspaId", "DataSourceType" ] }, { "name": "DescribeDSPAESDataAssetByComplianceId", "description": "根据合规组id，去查询ES的概览页统计数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "BuildType", "type": "string", "required": false, "description": "云上还是自建", "example": "cloud" }, { "name": "DataSourceType", "type": "string", "required": false, "description": "数据源类型", "example": "es" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPAESDataAssetDetail", "description": "根据合规组id，去查询ES的概览页下的统计列表数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制条目数", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "[{\"Name\":\"DataSourceType\",\"Values\":[\"es\"]},{\"Name\":\"BuildType\",\"Values\":[\"cloud\"]},{\"Name\":\"SensitiveField\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"cdb\",\"mariadb\"]", "item_type": "string" } ] }, { "name": "CreditScore", "type": "string", "required": false, "description": "可信分排序，ASC升序 DESC降序", "example": "ASC" } ], "required": [ "DspaId", "ComplianceId", "Offset", "Limit" ] }, { "name": "DescribeDSPAESDataSample", "description": "获取ES扫描结果数据样本", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "FieldResultId", "type": "integer", "required": true, "description": "字段扫描结果ID", "example": "10000" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "random" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段", "example": "id" } ], "required": [ "DspaId", "FieldResultId" ] }, { "name": "DescribeDSPAESDiscoveryTaskResultDetail", "description": "获取ES的分类分级任务结果详情，该接口只有在任务状态为时才支持结果正确查询： 3 扫描成功", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-9as8cz2s" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回数量，默认值为20，最大值为100", "example": "1" }, { "name": "CategoryIdList", "type": "array", "required": false, "description": "多级分类的分类ID集合", "example": "[1]", "item_type": "integer" }, { "name": "LevelId", "type": "integer", "required": false, "description": "敏感数据分级ID", "example": "1" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "t_order" } ], "required": [ "DspaId", "TaskId", "ComplianceId", "Offset", "Limit" ] }, { "name": "DescribeDSPALevelDetail", "description": "获取分级详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-ab50f3b1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组。支持的Name： ComplianceId 合规组ID LevelGroupId 敏感分级组ID", "example": "[{\"Name\":\"LevelGroupId\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"cdb\",\"mariadb\"]", "item_type": "string" } ] } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPALevelGroups", "description": "获取分级列表，限制100个 不分页返回", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-980ad23a" }, { "name": "Name", "type": "string", "required": false, "description": "分级组名称", "example": "默认分级组" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页返回的记录数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "从第几条记录开始返回", "example": "0" } ], "required": [ "DspaId" ] }, { "name": "DescribeDSPARDBDataAssetByComplianceId", "description": "获取单个合规组下的RDB关系数据库分类分级数据资产", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-89asd23n" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "DataSourceType", "type": "string", "required": false, "description": "数据源类型，不填默认过滤非自建的所有关系型数据源类型，填selfbuilt-db只过滤自建类型", "example": "selfbuilt-db" }, { "name": "BuildType", "type": "string", "required": false, "description": "自建还是云上", "example": "cloud" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPARDBDataAssetDetail", "description": "获取RDB关系数据库分类分级资产详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id", "example": "dspa-001" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组Id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组。支持的Name： DataSourceID 数据源ID DbName 数据库名称 CategoryID 敏感数据分类ID RuleID 规则ID LevelID 敏感分级ID ResourceRegion 资源所在地域 SensitiveField 过滤敏感字段，可选值为1，或者无此SensitiveField字段 DataSourceType 数据源类型，不填默认过滤非自建的所有关系型数据源类型，填selfbuilt-db只过滤自建类型 注意：每个name默认支持最多5个values。", "example": "[{\"Name\":\"DataSourceType\",\"Values\":[\"cdb\",\"dcdb\",\"mariadb\",\"postgres\",\"cynosdbmysql\"]},{\"Name\":\"BuildType\",\"Values\":[\"cloud\"]},{\"Name\":\"SensitiveField\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"cdb\",\"mariadb\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "1" }, { "name": "CreditScore", "type": "string", "required": false, "description": "可信分排序，ASC-升序 DESC降序", "example": "ASC" } ], "required": [ "DspaId", "ComplianceId" ] }, { "name": "DescribeDSPASupportedMetas", "description": "拉取DSPA支持的Meta元数据类型，返回包括：元数据类型，支持的元数据地域信息", "status": "online", "parameters": [ { "name": "MetaTypes", "type": "array", "required": false, "description": "元数据类型", "example": "cdb", "item_type": "string" } ], "required": [] }, { "name": "DescribeDSPATaskResultDataSample", "description": "获取扫描结果数据样本", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "FieldResultId", "type": "integer", "required": true, "description": "字段扫描结果ID", "example": "10000" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "random" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段", "example": "id" } ], "required": [ "DspaId", "FieldResultId" ] }, { "name": "DescribeESAssetSensitiveDistribution", "description": "数据资产报告-查询es的敏感资产报告，包含（数据库资产，设敏级别数据库top10，资产详情）", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产信息列表", "example": "[{\"DataSourceType\":\"cos\",\"DataSourceInfo\":[{\"\"}]}]", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DescribeExportTaskResult", "description": "获取导出任务结果", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xx" }, { "name": "ExportTaskId", "type": "integer", "required": true, "description": "导出任务id", "example": "1" } ], "required": [ "DspaId", "ExportTaskId" ] }, { "name": "DescribeMongoAssetSensitiveDistribution", "description": "数据资产报告-查询mongo 的敏感资产报告，包含（数据库资产，设敏级别数据库top10，资产详情）", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-12cd45g7" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产信息列表", "example": "[{\"DataSourceId\":\"cdb-5vskqwec\",\"BindList\":[\"Testcasb\"]}]", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DescribeRDBAssetSensitiveDistribution", "description": "数据资产报告-查询rbd 的敏感资产报告，包含（数据库资产，设敏级别数据库top10，资产详情）", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-b1c289ad" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产信息列表", "example": "{\"DataSourceType\":\"cdb\",\"DataSourceInfo\":[{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}]}", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DescribeReportTaskDownloadUrl", "description": "获取报表下载链接", "status": "online", "parameters": [ { "name": "ReportTaskId", "type": "integer", "required": true, "description": "任务id", "example": "1" }, { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dsap-asada" }, { "name": "IsWithSensitiveDetailReport", "type": "boolean", "required": false, "description": "是否同时下载敏感资产详情报告", "example": "true" } ], "required": [ "ReportTaskId", "DspaId" ] }, { "name": "DescribeReportTasks", "description": "获取资产报表任务列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "0" }, { "name": "ReportName", "type": "string", "required": false, "description": "报表名称", "example": "资产报告" } ], "required": [ "DspaId", "Limit", "Offset" ] }, { "name": "DescribeSensitiveCOSDataDistribution", "description": "数据资产报告-查询cos的敏感数据分布（分级分布 分类分布 敏感规则分布详情列表）", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "2331", "example": "1" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产信息列表", "example": "无", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DescribeSensitiveRDBDataDistribution", "description": "数据资产报告-查询rdb的敏感数据分布-敏感规则字段分布-敏感分布详情", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa-实例id", "example": "dspa-a1b2c3" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "2" }, { "name": "AssetList", "type": "array", "required": true, "description": "查询的资产信息列表", "example": "无", "item_type": "object", "children": [ { "name": "DataSourceType", "type": "string", "required": true, "description": "数据源类型", "example": "cos" }, { "name": "DataSourceInfo", "type": "array", "required": true, "description": "数据源信息", "example": "{\"DataSourceId\":\"cdb-b1c2\",\"BindList\":[\"db_asset\"]}", "item_type": "object", "children": [ { "name": "DataSourceId", "type": "string", "required": true, "description": "数据源ID", "example": "cdb-b1c2d3" }, { "name": "BindList", "type": "array", "required": false, "description": "针对rbd-就是绑定的db_name", "example": "[\"db_name\",\"security_asset\"]", "item_type": "string" } ] } ] } ], "required": [ "DspaId", "ComplianceId", "AssetList" ] }, { "name": "DisableDSPAMetaResourceAuth", "description": "取消用户云资源授权", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-ab21" }, { "name": "MetaType", "type": "string", "required": true, "description": "资源类型。", "example": "cdb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "ResourceIDs", "type": "array", "required": true, "description": "用户云资源ID列表。", "example": "cbd-a1b2c3", "item_type": "string" } ], "required": [ "DspaId", "MetaType", "ResourceRegion", "ResourceIDs" ] }, { "name": "EnableDSPADiscoveryRule", "description": "打开或者关闭分类分级规则 注：此API同时对该规则下的RDB跟COS规则操作。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "RuleId", "type": "integer", "required": true, "description": "规则ID", "example": "1" }, { "name": "Enable", "type": "boolean", "required": true, "description": "开关ScanRule", "example": "true" } ], "required": [ "DspaId", "RuleId", "Enable" ] }, { "name": "EnableTrialVersion", "description": "启用版本体验", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2" }, { "name": "TrialVersion", "type": "string", "required": true, "description": "体验版本名称。", "example": "standard" } ], "required": [ "DspaId", "TrialVersion" ] }, { "name": "ExportAssetDetailData", "description": "创建敏感数据导出任务", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组id", "example": "1" }, { "name": "MetaDataType", "type": "string", "required": true, "description": "资产类型（rdb,cvm_db,cos）", "example": "rdb" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组。支持的Name： DataSourceID 数据源ID DbName 数据库名称 CategoryID 敏感数据分类ID RuleID 规则ID LevelID 敏感分级ID ResourceRegion 资源所在地域 DataSourceType 数据源类型，不填默认过滤非自建的所有关系型数据源类型，填selfbuilt-db只过滤自建类型 注意：每个name默认支持最多5个values。", "example": "[{Name: \"DataSourceType\", Values: [\"cdb\", \"dcdb\", \"mariadb\", \"postgres\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"cdb\",\"mariadb\"]", "item_type": "string" } ] }, { "name": "CasbId", "type": "string", "required": false, "description": "casbId", "example": "casb-tlqkc3r0" } ], "required": [ "DspaId", "ComplianceId", "MetaDataType" ] }, { "name": "GetResourceConnectionStatus", "description": "获取授权资源的连接状态", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-ab32dca1" }, { "name": "MetaType", "type": "string", "required": true, "description": "资源类型。", "example": "cdb" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所处地域。", "example": "ap-guangzhou" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源列表中展示的资源ID。", "example": "cdb-a1b2" } ], "required": [ "DspaId", "MetaType", "ResourceRegion", "ResourceId" ] }, { "name": "GetTrialVersion", "description": "获取体验版本信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2c3" } ], "required": [ "DspaId" ] }, { "name": "GetUserQuotaInfo", "description": "获取用户购买配额信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2" } ], "required": [ "DspaId" ] }, { "name": "ListDSPAClusters", "description": "拉取DSPA集群列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "分页步长，默认为100。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤项。 支持的过滤项包括：DspaId、Status、Version、DspaName、Channel。 DspaId和DspaName支持模糊搜索。 Status支持的可选值：enabled、disabled。 Version支持的可选值：trial、official。 Channel支持的可选值：sp_cds_dsgc_pre（代表dsgc实例）、sp_cds_dsgc_wedata_dc（代表wedata实例）", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] }, { "name": "TagFilter", "type": "array", "required": false, "description": "Tag键值过滤", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value1" }, { "name": "Category", "type": "string", "required": false, "description": "标签所属类别", "example": "category1" } ] }, { "name": "ListMode", "type": "string", "required": false, "description": "展示模式。 目前只有两个值的处理逻辑： 空值：需要查询每个实例的配额信息，因为是串行查询，所以速度很慢，limit最大为100 \"simple\"：不需要查询每个实例的配额信息，速度快，limit最大为1000", "example": "simple" } ], "required": [] }, { "name": "ListDSPACosMetaResources", "description": "本接口用于获取COS元数据信息，返回COS元数据信息列表。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "实例Id", "example": "dspa-12311" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组。支持的Name： Bucket - 桶名，支持模糊匹配 ResoureRegion - 资源所处地域，需要填写完整地域名称，不支持模糊匹配。 Valid -- 资源是否有效，\"1\" 表示有效，\"0\"表示无效。", "example": "[filter]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为100。", "example": "100" }, { "name": "BindType", "type": "string", "required": false, "description": "资源绑定状态过滤，默认为全部", "example": "binded" } ], "required": [ "DspaId" ] }, { "name": "ListDSPAMetaResources", "description": "拉取用户云资源", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2c3d4" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤项。 可过滤值包括： ResoureRegion - 资源所处地域，需要填写完整地域名称，不支持模糊匹配。 AuthStatus - authorized（已授权）、unauthorized（未授权）、deleted（资源已被删除），不支持模糊匹配，需要填写完整。 BuildType - cloud（云原生资源）、build（用户自建资源），不支持模糊匹配，需要填写完整。 MetaType - cdb（云数据Mysql）、dcdb（TDSQL MySQL版）、mariadb（云数据库 MariaDB）、...", "example": "[ { \"Name\":\"ResourceId\", \"Values\":[ \"mariadb-9loqa8ed\" ] } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤类型。", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤类型的值。", "example": "value", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "分页步长，默认为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认为0。", "example": "0" }, { "name": "BindType", "type": "string", "required": false, "description": "资源绑定状态过滤，默认为全部", "example": "binded" } ], "required": [ "DspaId" ] }, { "name": "ModifyDSPAAssessmentRisk", "description": "修改DSPA评估风险项，支持修改Status", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "TaskId", "type": "string", "required": true, "description": "评估任务Id，格式“task-xxxxxxxx”", "example": "task-xxxxxxx" }, { "name": "RiskId", "type": "string", "required": true, "description": "风险项Id，格式“risk-xxxxxxxx”", "example": "risk-xxxxxxxx" }, { "name": "Status", "type": "string", "required": true, "description": "风险项状态。（waiting:待处理，processing:处理中，finished:已处理）", "example": "processing" } ], "required": [ "DspaId", "TaskId", "RiskId", "Status" ] }, { "name": "ModifyDSPAAssessmentRiskLatest", "description": "修改最新评估风险项状态", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-97538993" }, { "name": "Status", "type": "string", "required": true, "description": "风险状态（waiting:待处理，processing:处理中，finished:已处理，ignored:已忽略）", "example": "finished" }, { "name": "Note", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "ProcessPeople", "type": "string", "required": false, "description": "处置人", "example": "willalm" }, { "name": "BathRiskIdList", "type": "array", "required": false, "description": "批量处理的列表", "example": "[1,2,3,4]", "item_type": "integer" } ], "required": [ "DspaId", "Status" ] }, { "name": "ModifyDSPAAssessmentRiskLevel", "description": "风险项页面----修改风险等级的详情数据", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "RiskLevelName", "type": "string", "required": true, "description": "风险等级名称", "example": "高风险" }, { "name": "RiskLevelDescription", "type": "string", "required": true, "description": "风险的描述", "example": "高风险" }, { "name": "RiskId", "type": "integer", "required": true, "description": "风险id", "example": "1" }, { "name": "ModifyRiskItem", "type": "array", "required": false, "description": "需要修改的风险列表", "example": "[ { \"Id\": 1278, \"SensitiveLevelId\": 12098, \"SensitiveLevelName\": \"高危\", \"VulnerabilityLevel\": \"high\", \"RiskLevel\": \"high\" } ]", "item_type": "object", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "存储id", "example": "1" }, { "name": "SensitiveLevelId", "type": "integer", "required": false, "description": "分类分级levelID", "example": "1" }, { "name": "SensitiveLevelName", "type": "string", "required": false, "description": "分类分级名称", "example": "高" }, { "name": "VulnerabilityLevel", "type": "string", "required": false, "description": "漏洞级别", "example": "高" }, { "name": "RiskLevel", "type": "string", "required": false, "description": "风险级别", "example": "高" } ] } ], "required": [ "DspaId", "RiskLevelName", "RiskLevelDescription", "RiskId" ] }, { "name": "ModifyDSPAAssessmentRiskTemplate", "description": "风险模板---修改风险模板", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-a1b2c3d4" }, { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称", "example": "template-1" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板id", "example": "1" }, { "name": "RiskLevelId", "type": "integer", "required": true, "description": "修改的风险等级id", "example": "1" }, { "name": "TemplateDescription", "type": "string", "required": false, "description": "模板的描述", "example": "template-desc" }, { "name": "RiskIdList", "type": "array", "required": false, "description": "脆弱项列表", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "DspaId", "TemplateName", "TemplateId", "RiskLevelId" ] }, { "name": "ModifyDSPACOSDiscoveryTask", "description": "修改COS分类分级任务，该接口只有在任务状态为以下状态时才支持正确修改： 0 待扫描， 2 扫描终止， 3 扫描成功， 4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "task" }, { "name": "Description", "type": "string", "required": false, "description": "任务描述，最大长度为1024个字符", "example": "扫描任务" }, { "name": "Enable", "type": "integer", "required": false, "description": "任务开关，0 关闭，1 启用", "example": "1" }, { "name": "GeneralRuleSetEnable", "type": "integer", "required": false, "description": "通用规则集开关；0 关闭，1 启用", "example": "1" }, { "name": "ComplianceGroupIds", "type": "array", "required": false, "description": "合规组ID列表，最多支持添加5个", "example": "[1,2]", "item_type": "integer" }, { "name": "Plan", "type": "integer", "required": false, "description": "执行计划； 0立即 1定时，选择“立即”时，扫描周期只能选择单次", "example": "1" }, { "name": "Period", "type": "integer", "required": false, "description": "扫描周期；0单次 1每天 2每周 3每月", "example": "1" }, { "name": "TimingStartTime", "type": "string", "required": false, "description": "任务定时启动时间，格式：2006-01-02 15:04:05 当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。", "example": "2006-01-02 15:04:05" }, { "name": "FileTypes", "type": "array", "required": false, "description": "待扫描文件类型，用逗号隔开，格式如：[\".txt\", \".csv\", \".log\", \".xml\",\".html\", \".json\"]。", "example": "[.txt,.csv]", "item_type": "string" }, { "name": "FileSizeLimit", "type": "integer", "required": false, "description": "文件大小上限，单位为KB，如1000, 目前单个文件最大只支持100MB（102400KB）", "example": "1000" }, { "name": "ResourceRegion", "type": "string", "required": false, "description": "资源所在地域", "example": "ap-guangzhou" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "ModifyDSPACOSTaskResult", "description": "调整COS任务扫描结果", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-xxx" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "FileResultId", "type": "integer", "required": true, "description": "文件扫描结果ID", "example": "1" }, { "name": "IsSetNonSensitiveFile", "type": "boolean", "required": false, "description": "是否设置为非敏感文件", "example": "true" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名", "example": "file1" }, { "name": "BucketName", "type": "string", "required": false, "description": "桶名", "example": "bucket-xx" }, { "name": "DataSourceId", "type": "string", "required": false, "description": "数据源id", "example": "cos-xxx" } ], "required": [ "DspaId", "ComplianceId", "FileResultId" ] }, { "name": "ModifyDSPACategory", "description": "修改分类，内置分类不支持修改。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "数据分类ID", "example": "1" }, { "name": "Name", "type": "string", "required": true, "description": "敏感数据分类名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "财务信息" } ], "required": [ "DspaId", "CategoryId", "Name" ] }, { "name": "ModifyDSPACategoryRelation", "description": "修改分类分级关系", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "dspa实例id", "example": "dspa-xxx" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "当前分类id", "example": "1" }, { "name": "MergedCategoryId", "type": "integer", "required": true, "description": "合并到的分类id", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组模板id", "example": "1" } ], "required": [ "DspaId", "CategoryId", "MergedCategoryId", "ComplianceId" ] }, { "name": "ModifyDSPAClusterInfo", "description": "修改DSPA集群信息", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2" }, { "name": "DspaName", "type": "string", "required": false, "description": "DSPA实例名。1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字。", "example": "default name" }, { "name": "DspaDescription", "type": "string", "required": false, "description": "DSPA实例描述信息。最长1024个字符。", "example": "default description" } ], "required": [ "DspaId" ] }, { "name": "ModifyDSPAComplianceGroup", "description": "修改分类分级模板，内置模板不支持修改。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "ComplianceGroupId", "type": "integer", "required": true, "description": "合规组ID", "example": "1000" }, { "name": "Name", "type": "string", "required": false, "description": "合规组名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "测试合规组" }, { "name": "Description", "type": "string", "required": false, "description": "合规组描述，最大长度为1024个字符", "example": "用于测试合规组" }, { "name": "ComplianceGroupRules", "type": "array", "required": false, "description": "合规组规则配置（参数已废弃，请传空数组）", "example": "[{\"RuleId\":2,\"CategoryId\":3,\"LevelId\":2}]", "item_type": "object", "children": [ { "name": "RuleId", "type": "integer", "required": true, "description": "敏感数据识别规则ID", "example": "1" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "敏感数据分类ID", "example": "1" }, { "name": "LevelId", "type": "integer", "required": true, "description": "敏感数据分级标识ID, 系统支持高、中、低三级，也支持自定义分级", "example": "1" } ] }, { "name": "LevelGroupId", "type": "integer", "required": false, "description": "分级组ID，新增参数，可选参数，默认值为1", "example": "1" }, { "name": "RuleAlias", "type": "boolean", "required": false, "description": "是否开启别名", "example": "false" } ], "required": [ "DspaId", "ComplianceGroupId" ] }, { "name": "ModifyDSPADiscoveryRule", "description": "修改分类分级规则，单个用户最多允许创建200个规则。 注：此API同时适用RDB跟COS类型数据。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-ab50f3b1" }, { "name": "Name", "type": "string", "required": true, "description": "规则名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "姓名" }, { "name": "RuleId", "type": "integer", "required": true, "description": "规则ID", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度为1024个字符", "example": "该规则用于匹配姓名" }, { "name": "RDBRules", "type": "object", "required": false, "description": "RDB类敏感数据识别规则", "example": "{ \"Status\": 1, \"MatchOperator\": \"and\", \"MetaRule\": { \"Operator\": \"and\", \"Contents\": [ { \"RuleType\": \"keyword\", \"RuleContent\": \"test\" } ] }, \"ContentRule\": { \"Operator\": \"and\", \"Contents\": [ { \"RuleType\": \"keyword\", \"RuleContent\": \"test\" } ] } }", "children": [ { "name": "Status", "type": "integer", "required": true, "description": "规则状态；0 不启用, 1 启用", "example": "1" }, { "name": "MatchOperator", "type": "string", "required": true, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一", "example": "and" }, { "name": "MetaRule", "type": "object", "required": true, "description": "字段名包含规则，最大支持选择9项", "example": "{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "操作符；只能取and, or的其中一种", "example": "and" }, { "name": "Contents", "type": "array", "required": true, "description": "规则", "example": "[{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}]", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型；取值： keyword 关键字, regex 正则", "example": "keyword" }, { "name": "RuleContent", "type": "string", "required": true, "description": "内容", "example": "phone" }, { "name": "ExtendParameters", "type": "array", "required": false, "description": "该字段是针对规则类型RuleType为keyword类型时的一个扩展属性", "example": "[{\"Value\":\"true\",\"Name\":\"IsFullWordMatch\"}]", "item_type": "string" } ] } ] }, { "name": "ContentRule", "type": "object", "required": true, "description": "内容包含规则，最大支持选择9项", "example": "{ \"Operator\":\"or\", \"Contents\":[{\"RuleType\":\"regex\",\"RuleContent\":\"^[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)+(com|cn|net|pk|om|it|za|nz|sg|ae|fm|sy|org|tr|ye|cy|gr|in|ru|de|il|au|vn|jp|zm|ar|mk|gn|mx|es|fr|zw|ci|na|np|to|id|ie|sa|mn|uk|se|at)$\"}]}", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "操作符；只能取and, or的其中一种", "example": "and" }, { "name": "Contents", "type": "array", "required": true, "description": "规则", "example": "[{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}]", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型；取值： keyword 关键字, regex 正则", "example": "keyword" }, { "name": "RuleContent", "type": "string", "required": true, "description": "内容", "example": "phone" }, { "name": "ExtendParameters", "type": "array", "required": false, "description": "该字段是针对规则类型RuleType为keyword类型时的一个扩展属性", "example": "[{\"Value\":\"true\",\"Name\":\"IsFullWordMatch\"}]", "item_type": "string" } ] } ] } ] }, { "name": "COSRules", "type": "object", "required": false, "description": "COS类敏感数据识别规则", "example": "{ \"Status\": 1, \"MatchOperator\": \"and\", \"RegexRule\": { \"Operator\": \"or\", \"Contents\": [ { \"RuleContent\": \"(?\u003c=\\\\D)(\\\\d{4} \\\\d{4} \\\\d{4} \\\\d{4} \\\\d{3}|\\\\d{6} \\\\d{4} \\\\d{4} \\\\d{5}|\\\\d{13,19}|\\\\d{4} \\\\d{4} \\\\d{4} \\\\d{4})(?=\\\\D)\" } ] }, MaxMatch: 100 }", "children": [ { "name": "RegexRule", "type": "object", "required": true, "description": "regex规则内容", "example": " { \"Operator\":\"or\", \"Contents\":[{\"RuleType\":\"regex\",\"RuleContent\":\"^[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)+(com|cn|net|pk|om|it|za|nz|sg|ae|fm|sy|org|tr|ye|cy|gr|in|ru|de|il|au|vn|jp|zm|ar|mk|gn|mx|es|fr|zw|ci|na|np|to|id|ie|sa|mn|uk|se|at)$\"}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"(?\u003c=\\\\W)[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)\"}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": true, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态；0 不启用, 1 启用", "example": "1" }, { "name": "KeywordRule", "type": "object", "required": false, "description": "关键词规则内容组，最大支持5个关键词。", "example": "{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"(?\u003c=\\\\W)[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)\"}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": true, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "IgnoreStringRule", "type": "object", "required": false, "description": "忽略词规则内容组，最大支持5个忽略词。", "example": "{\"Operator\":\"and\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"keyword\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"(?\u003c=\\\\W)[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)\"}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": true, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "MaxMatch", "type": "integer", "required": false, "description": "最大匹配距离，默认值为100。上限为500.", "example": "100" } ] }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态", "example": "0" } ], "required": [ "DspaId", "Name", "RuleId" ] }, { "name": "ModifyDSPADiscoveryTask", "description": "修改分类分级任务，该接口只有在任务状态为以下状态时才支持正确修改： 0 待扫描， 2 扫描终止， 3 扫描成功， 4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "任务名称，1-60个字符，仅允许输入中文、英文字母、数字、'_'、'-'，并且开头和结尾需为中文、英文字母或者数字，Name不可重复", "example": "task" }, { "name": "Description", "type": "string", "required": false, "description": "任务描述，最大长度为1024个字符", "example": "扫描任务" }, { "name": "Enable", "type": "integer", "required": false, "description": "任务开关，0 关闭，1 启用", "example": "1" }, { "name": "DataSourceId", "type": "string", "required": false, "description": "数据源ID", "example": "datasource-00000000" }, { "name": "Condition", "type": "string", "required": false, "description": "用于传入的数据源的条件，目前只支持数据库，所以目前表示数据库的名称，最多添加5个数据库，之间通过逗号分隔", "example": "db_1,db_2" }, { "name": "GeneralRuleSetEnable", "type": "integer", "required": false, "description": "通用规则集开关；0 关闭，1 启用", "example": "1" }, { "name": "ComplianceGroupIds", "type": "array", "required": false, "description": "合规组ID列表，最多支持添加5个", "example": "[1,2]", "item_type": "integer" }, { "name": "Plan", "type": "integer", "required": false, "description": "执行计划； 0立即 1定时，选择“立即”时，扫描周期只能选择单次", "example": "1" }, { "name": "Period", "type": "integer", "required": false, "description": "扫描周期；0单次 1每天 2每周 3每月", "example": "1" }, { "name": "TimingStartTime", "type": "string", "required": false, "description": "任务定时启动时间，格式：2006-01-02 15:04:05 当执行计划（Plan字段）为”立即“时，定时启动时间不会生效，此场景下给该字段传值不会被保存。", "example": "2006-01-02 15:04:05" }, { "name": "ResourceRegion", "type": "string", "required": false, "description": "资源所在地域", "example": "ap-guangzhou" }, { "name": "DataSourceType", "type": "string", "required": false, "description": "数据源类型，可取值如下： cdb 表示云数据库 MySQL, dcdb 表示TDSQL MySQL版, mariadb 表示云数据库 MariaDB, postgres 表示云数据库 PostgreSQL, cynosdbpg 表示TDSQL-C PostgreSQL版, cynosdbmysql 表示TDSQL-C MySQL版, selfbuilt-db 表示自建数据库", "example": "cdb" }, { "name": "ScanRange", "type": "string", "required": false, "description": "full:全量扫描 incre:变更扫描", "example": "full" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "ModifyDSPAESTaskResult", "description": "调整ES任务扫描结果", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-xxx" }, { "name": "FieldResultId", "type": "integer", "required": true, "description": "字段扫描结果ID", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "IsSetNonSensitiveField", "type": "boolean", "required": false, "description": "是否设置为非敏感字段", "example": "true" }, { "name": "DestRuleId", "type": "integer", "required": false, "description": "调整后新的规则ID", "example": "1" }, { "name": "DestCategoryId", "type": "integer", "required": false, "description": "调整后新的分类ID", "example": "1" }, { "name": "DestLevelId", "type": "integer", "required": false, "description": "调整后新的分级ID", "example": "1" }, { "name": "SrcRuleId", "type": "integer", "required": false, "description": "调整前的规则id（系统识别的id）", "example": "1" }, { "name": "SrcCategoryId", "type": "integer", "required": false, "description": "调整前的规则id（系统识别的id）", "example": "1" }, { "name": "SrcLevelId", "type": "integer", "required": false, "description": "调整前的等级id", "example": "1" }, { "name": "IdentifyType", "type": "integer", "required": false, "description": "0系统识别，1人工打标", "example": "识别方式" } ], "required": [ "DspaId", "FieldResultId", "ComplianceId" ] }, { "name": "ModifyDSPATaskResult", "description": "调整任务扫描结果", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-xxx" }, { "name": "FieldResultId", "type": "integer", "required": true, "description": "字段扫描结果ID", "example": "1" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "合规组ID", "example": "1" }, { "name": "IsSetNonSensitiveField", "type": "boolean", "required": false, "description": "是否设置为非敏感字段", "example": "true" }, { "name": "DestRuleId", "type": "integer", "required": false, "description": "调整后新的规则ID", "example": "1" }, { "name": "DestCategoryId", "type": "integer", "required": false, "description": "调整后新的分类ID", "example": "1" }, { "name": "DestLevelId", "type": "integer", "required": false, "description": "调整后新的分级ID", "example": "1" }, { "name": "SrcRuleId", "type": "integer", "required": false, "description": "调整前的规则ID", "example": "1" }, { "name": "SrcCategoryId", "type": "integer", "required": false, "description": "调整之前的分类id", "example": "1" }, { "name": "SrcLevelId", "type": "integer", "required": false, "description": "调整之前的分级id", "example": "1" }, { "name": "IdentifyType", "type": "integer", "required": false, "description": "识别方式 0-系统识别，1-人工打标", "example": "0" } ], "required": [ "DspaId", "FieldResultId", "ComplianceId" ] }, { "name": "QueryDSPAMetaResourceDbList", "description": "查询DSPA实例的db列表", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-ab50f3b1" }, { "name": "ResourceId", "type": "string", "required": true, "description": "数据库实例ID。", "example": "cdb-6cmpe42v" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "数据库实例所在地域。", "example": "ap-guangzhou" }, { "name": "MetaType", "type": "string", "required": true, "description": "数据库实例类型。", "example": "cdb" } ], "required": [ "DspaId", "ResourceId", "ResourceRegion", "MetaType" ] }, { "name": "QueryResourceDbBindStatus", "description": "获取资源绑定DB状态", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-aaa" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID。", "example": "10" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "资源所在地域。", "example": "ap-guangzhou" }, { "name": "MetaType", "type": "string", "required": true, "description": "资源类型。", "example": "cdb" } ], "required": [ "DspaId", "ResourceId", "ResourceRegion", "MetaType" ] }, { "name": "RestartDSPAAssessmentTask", "description": "重新启动DSPA风险评估任务", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例Id，格式“dspa-xxxxxxxx”", "example": "dspa-ad0gf4ks" }, { "name": "TaskId", "type": "string", "required": true, "description": "评估任务Id，格式“task-xxxxxxxx”", "example": "task-xxxxxxxx" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "StartDSPADiscoveryTask", "description": "立即启动分类分级任务，该接口只有在任务状态为以下状态时才支持正确执行立即扫描： 0 待扫描， 2 扫描终止， 3 扫描成功， 4 扫描失败", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "StopDSPADiscoveryTask", "description": "停止分类分级任务，该接口只有在任务状态为以下状态时才支持正确执行停止扫描： 1 扫描中", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-001" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" } ], "required": [ "DspaId", "TaskId" ] }, { "name": "UpdateDSPASelfBuildResource", "description": "更新自建资源基础信息，包括：端口、账户名、密码。 请注意： 如果资源自身的VPC、VIP信息发生变化，后台会自动更新。 如果监听的端口发生变化，请显式输入端口。 如果账户名密码任意一个发生变化，请务必同时显式输入账户名密码。", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID。", "example": "dspa-a1b2" }, { "name": "ResourceId", "type": "string", "required": true, "description": "云资源名称，如果是通过CVM访问则填写CVM的资源ID，如果是通过LB访问则填写LB的资源ID。", "example": "c231" }, { "name": "ResourceVPort", "type": "integer", "required": false, "description": "资源绑定的端口，为0则表示不更新。", "example": "2204" }, { "name": "UserName", "type": "string", "required": false, "description": "账户名，为空则表示不更新。 UserName和Password必须同时填写或同时为空。", "example": "admin" }, { "name": "Password", "type": "string", "required": false, "description": "账户密码，为空则表示不更新。 UserName和Password必须同时填写或同时为空。", "example": "pass" }, { "name": "AuthRange", "type": "string", "required": false, "description": "授权范围：all 授权全部 manual：手动指定", "example": "all" }, { "name": "ResourceName", "type": "string", "required": false, "description": "自建数据资产的名称，支持修改", "example": "我的自建资产" } ], "required": [ "DspaId", "ResourceId" ] }, { "name": "VerifyDSPACOSRule", "description": "验证COS分类分级规则", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-ab50f3b1" }, { "name": "COSRules", "type": "object", "required": true, "description": "待验证COS规则", "example": "{ \"MaxMatch\": 100, \"RegexRule\": { \"Operator\": \"or\", \"Contents\": [ { \"RuleContent\": \"test\", \"IsIgnoreCase\": true } ] }, \"KeywordRule\": { \"Operator\": \"or\", \"Contents\": [ { \"RuleContent\": \"test\", \"IsIgnoreCase\": true } ] }, \"IgnoreStringRule\": { \"Operator\": \"or\" } }", "children": [ { "name": "RegexRule", "type": "object", "required": true, "description": "regex规则内容", "example": " { \"Operator\":\"or\", \"Contents\":[{\"RuleType\":\"regex\",\"RuleContent\":\"^[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)+(com|cn|net|pk|om|it|za|nz|sg|ae|fm|sy|org|tr|ye|cy|gr|in|ru|de|il|au|vn|jp|zm|ar|mk|gn|mx|es|fr|zw|ci|na|np|to|id|ie|sa|mn|uk|se|at)$\"}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"(?\u003c=\\\\W)[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)\"}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": true, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态；0 不启用, 1 启用", "example": "1" }, { "name": "KeywordRule", "type": "object", "required": false, "description": "关键词规则内容组，最大支持5个关键词。", "example": "{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"(?\u003c=\\\\W)[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)\"}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": true, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "IgnoreStringRule", "type": "object", "required": false, "description": "忽略词规则内容组，最大支持5个忽略词。", "example": "{\"Operator\":\"and\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"keyword\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"}]}]}", "children": [ { "name": "Operator", "type": "string", "required": false, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一. 默认值为or", "example": "and" }, { "name": "Contents", "type": "array", "required": false, "description": "规则内容", "example": "[{\"RuleContent\":\"(?\u003c=\\\\W)[\\\\w-]+(\\\\.[\\\\w-]+)*@([\\\\w-]+\\\\.)\"}]", "item_type": "object", "children": [ { "name": "RuleContent", "type": "string", "required": true, "description": "规则内容，可以是正则规则，关键词， 忽略词扥", "example": "word" }, { "name": "IsIgnoreCase", "type": "boolean", "required": false, "description": "是否区分大小写 false: 不区分大小写 true:区分大小写", "example": "true" } ] } ] }, { "name": "MaxMatch", "type": "integer", "required": false, "description": "最大匹配距离，默认值为100。上限为500.", "example": "100" } ] }, { "name": "Data", "type": "string", "required": true, "description": "待验证数据", "example": "data_to_verify" } ], "required": [ "DspaId", "COSRules", "Data" ] }, { "name": "VerifyDSPADiscoveryRule", "description": "验证分类分级规则", "status": "online", "parameters": [ { "name": "DspaId", "type": "string", "required": true, "description": "DSPA实例ID", "example": "dspa-ab50f3b1" }, { "name": "MatchOperator", "type": "string", "required": true, "description": "只能取and 、or两个值其中之一，and：字段和内容同时满足，or：字段和内容满足其一", "example": "and" }, { "name": "MetaRule", "type": "object", "required": false, "description": "字段名包含规则，最大支持选择9项", "example": "{ \"Operator\": \"and\", \"Contents\": [ { \"RuleType\": \"keyword\", \"RuleContent\": \"test\" } ] }", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "操作符；只能取and, or的其中一种", "example": "and" }, { "name": "Contents", "type": "array", "required": true, "description": "规则", "example": "[{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}]", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型；取值： keyword 关键字, regex 正则", "example": "keyword" }, { "name": "RuleContent", "type": "string", "required": true, "description": "内容", "example": "phone" }, { "name": "ExtendParameters", "type": "array", "required": false, "description": "该字段是针对规则类型RuleType为keyword类型时的一个扩展属性", "example": "[{\"Value\":\"true\",\"Name\":\"IsFullWordMatch\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "扩展参数名称，目前支持如下两个扩展属性名称： IsFullWordMatch，表示是否全文匹配，该Name对应的Value可取值为\"true\"或\"false\":，默认值为\"false\"， IsIgnoreCase，表示是否忽略大小写，该Name对应的Value可取值为\"true\"或\"false\"，默认值为\"true\"", "example": "IsFullWordMatch" }, { "name": "Value", "type": "string", "required": false, "description": "扩展参数值", "example": "\"true\"" } ] } ] } ] }, { "name": "ContentRule", "type": "object", "required": false, "description": "内容包含规则，最大支持选择9项", "example": "{ \"Operator\": \"and\", \"Contents\": [ { \"RuleType\": \"keyword\", \"RuleContent\": \"test\" } ] }", "children": [ { "name": "Operator", "type": "string", "required": true, "description": "操作符；只能取and, or的其中一种", "example": "and" }, { "name": "Contents", "type": "array", "required": true, "description": "规则", "example": "[{\"Operator\":\"or\",\"Contents\":[{\"RuleType\":\"keyword\",\"RuleContent\":\"url\",\"ExtendParameters\":[{\"Name\":\"IsFullWordMatch\",\"Value\":\"false\"},{\"Name\":\"IsIgnoreCase\",\"Value\":\"true\"}]}]}]", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型；取值： keyword 关键字, regex 正则", "example": "keyword" }, { "name": "RuleContent", "type": "string", "required": true, "description": "内容", "example": "phone" }, { "name": "ExtendParameters", "type": "array", "required": false, "description": "该字段是针对规则类型RuleType为keyword类型时的一个扩展属性", "example": "[{\"Value\":\"true\",\"Name\":\"IsFullWordMatch\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "扩展参数名称，目前支持如下两个扩展属性名称： IsFullWordMatch，表示是否全文匹配，该Name对应的Value可取值为\"true\"或\"false\":，默认值为\"false\"， IsIgnoreCase，表示是否忽略大小写，该Name对应的Value可取值为\"true\"或\"false\"，默认值为\"true\"", "example": "IsFullWordMatch" }, { "name": "Value", "type": "string", "required": false, "description": "扩展参数值", "example": "\"true\"" } ] } ] } ] }, { "name": "VerifyMeta", "type": "string", "required": false, "description": "验证规则字段名，最大长度为1024个字符", "example": "姓名" }, { "name": "VerifyContent", "type": "string", "required": false, "description": "验证规则数据内容，最大长度为1024个字符", "example": "TEST" } ], "required": [ "DspaId", "MatchOperator" ] } ] }