diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/sddp | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/sddp')
| -rw-r--r-- | data/en_us/sddp/2019-01-03/api-docs.php | 12964 |
1 files changed, 12964 insertions, 0 deletions
diff --git a/data/en_us/sddp/2019-01-03/api-docs.php b/data/en_us/sddp/2019-01-03/api-docs.php new file mode 100644 index 0000000..bbacfa8 --- /dev/null +++ b/data/en_us/sddp/2019-01-03/api-docs.php @@ -0,0 +1,12964 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Sddp', + 'version' => '2019-01-03', + ], + 'directories' => [ + [ + 'id' => 262682, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeAuditLogs', + ], + ], + [ + 'id' => 262684, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSlrRole', + ], + ], + [ + 'id' => 262686, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DeleteDataLimit', + 'DescribeDataLimits', + 'ModifyDataLimit', + 'DescribeDataLimitDetail', + 'CreateDataLimit', + 'DescribeDataLimitSet', + 'DescribeInstanceSources', + 'DescribeParentInstance', + ], + ], + [ + 'id' => 262695, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ScanOssObjectV1', + 'CreateScanTask', + 'ModifyDefaultLevel', + 'ModifyRuleStatus', + 'ModifyRule', + 'DeleteRule', + 'CreateRule', + ], + ], + [ + 'id' => 262703, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeRules', + 'DescribeRiskLevels', + 'DescribeDataAssets', + 'DescribeInstances', + 'DescribeTables', + 'DescribeColumns', + 'DescribeColumnsV2', + 'DescribeOssObjects', + 'DescribeOssObjectDetail', + 'DescribeOssObjectDetailV2', + 'DescribePackages', + 'DescribeCategoryTemplateList', + 'DescribeCategoryTemplateRuleList', + 'DescribeTemplateAllRules', + 'DescribeDocTypes', + 'DescribeDataObjects', + 'DescribeDataObjectColumnDetail', + 'DescribeDataObjectColumnDetailV2', + ], + ], + [ + 'id' => 262722, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateConfig', + 'DescribeConfigs', + 'ModifyReportTaskStatus', + 'DescribeUserStatus', + 'DisableUserConfig', + ], + ], + [ + 'id' => 262728, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyEventTypeStatus', + 'ModifyEventStatus', + 'DescribeEvents', + 'DescribeEventDetail', + 'DescribeEventTypes', + ], + ], + [ + 'id' => 262734, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDataMaskingTasks', + 'DescribeDataMaskingRunHistory', + 'ExecDatamask', + 'StopMaskingProcess', + 'ManualTriggerMaskingProcess', + ], + ], + [ + 'id' => 262740, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeIdentifyTaskStatus', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'RestoreOssImage', + 'MaskOssImage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeAuditLogs' => [ + 'summary' => '查询审计告警日志列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81992', + 'abilityTreeNodes' => [ + 'FEATUREsddpH8R72I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.*.*.94', + ], + ], + [ + 'name' => 'ClientUa', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zeftaaq4gqcqb9kfkzg', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'bose_o2o_data', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1616068534877', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1583856000000', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'SqlText', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'select * from test03', + ], + ], + [ + 'name' => 'ExecuteTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'in[1000 2000]', + ], + ], + [ + 'name' => 'EffectRowRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'in[1 33]', + ], + ], + [ + 'name' => 'RuleID', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '994007', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Insert', + ], + ], + [ + 'name' => 'OssObjectKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-key', + ], + ], + [ + 'name' => 'AsyncRequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CE4681BA-8019-5BE1-9F4B-8973BEA9CF57', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'LoadWhiteList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MemberAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '**********8103', + ], + ], + [ + 'name' => 'IpType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'LogQueryOpJson', + 'in' => 'query', + 'schema' => [ + 'title' => '查询条件是否包含的json字符串', + 'type' => 'string', + 'example' => '[ { "isContain" : false, "queryKey" : "effectRowRange" }, { "isContain" : false, "queryKey" : "remoteClientIp" } ]', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'LogSource', + 'in' => 'query', + 'schema' => [ + 'title' => '数据来源', + 'type' => 'string', + 'example' => 'SLOW_SQL', + ], + ], + [ + 'name' => 'RuleAggQuery', + 'in' => 'query', + 'schema' => [ + 'title' => '是否聚合查询', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AsyncRequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CE4681BA-8019-5BE1-9F4B-8973BEA9CF57'."\n", + ], + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A7021857-AFD9-5AD6-979D-AA7DFC5AFADF', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1536751124000', + ], + 'WarnLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'ClientPort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '35756', + ], + 'TableName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'it_table', + ], + 'EffectRow' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PackageName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'com.sinosoft.chinalife', + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19********94', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9952275', + ], + 'OperateType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Drop', + ], + 'LogTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1751870592000', + ], + 'WarnLevelName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rm-1234', + ], + 'DatabaseName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'chngc_b2b_migration_sh', + ], + 'OssObjectKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss-key1', + ], + 'ExecuteStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProductId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'ExecuteTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1751870592000', + ], + 'UserName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'admin', + ], + 'InstanceDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'instance dscription', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'name', + ], + 'ColumnName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hide14', + ], + 'ClientIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '139.*.*.57', + ], + 'ClientUa' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mysql', + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RDS', + ], + 'SqlText' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'select schema_name, catalog_name, default_character_set_name as encoding from information_schema.schemata order by 1', + ], + 'InWhiteList' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MemberAccount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '**********8103', + ], + 'RuleCategory' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'IpType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aliyun', + ], + 'ModelName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DataSet' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'plan_id ~ application_id ~ plan_type ~ plan_name ~ plan_value_id', + ], + 'LogSource' => [ + 'title' => '数据来源', + 'type' => 'string', + 'example' => 'SLOW_SQL', + ], + 'InstanceAuditStatus' => [ + 'title' => '实例审计状态', + 'type' => 'string', + 'example' => '2', + ], + 'DbType' => [ + 'title' => '数据库类型', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AsyncRequestId\\": \\"CE4681BA-8019-5BE1-9F4B-8973BEA9CF57\\\\n\\",\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A7021857-AFD9-5AD6-979D-AA7DFC5AFADF\\",\\n \\"TotalCount\\": 12,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1536751124000,\\n \\"WarnLevel\\": \\"2\\",\\n \\"ClientPort\\": \\"35756\\",\\n \\"TableName\\": \\"it_table\\",\\n \\"EffectRow\\": 10,\\n \\"PackageName\\": \\"test01\\",\\n \\"UserId\\": \\"19********94\\",\\n \\"Message\\": \\"success\\",\\n \\"RuleId\\": \\"9952275\\",\\n \\"OperateType\\": \\"Drop\\",\\n \\"LogTime\\": 1751870592000,\\n \\"WarnLevelName\\": \\"高危\\",\\n \\"InstanceName\\": \\"rm-1234\\",\\n \\"DatabaseName\\": \\"chngc_b2b_migration_sh\\",\\n \\"OssObjectKey\\": \\"oss-key1\\",\\n \\"ExecuteStatus\\": 1,\\n \\"ProductId\\": 5,\\n \\"ExecuteTime\\": 1751870592000,\\n \\"UserName\\": \\"admin\\",\\n \\"InstanceDescription\\": \\"instance dscription\\",\\n \\"RuleName\\": \\"name\\",\\n \\"ColumnName\\": \\"hide14\\",\\n \\"ClientIp\\": \\"139.*.*.57\\",\\n \\"ClientUa\\": \\"mysql\\",\\n \\"ProductCode\\": \\"RDS\\",\\n \\"SqlText\\": \\"select * from test03\\\\n\\",\\n \\"InWhiteList\\": true,\\n \\"MemberAccount\\": \\"**********8103\\",\\n \\"RuleCategory\\": \\"10\\",\\n \\"IpType\\": \\"aliyun\\",\\n \\"ModelName\\": \\"Identity Card\\",\\n \\"DataSet\\": \\"plan_id ~ application_id ~ plan_type ~ plan_name ~ plan_value_id\\",\\n \\"LogSource\\": \\"SLOW_SQL\\",\\n \\"InstanceAuditStatus\\": \\"2\\",\\n \\"DbType\\": \\"MySQL\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateSlrRole' => [ + 'summary' => 'Creates a service-linked role for Data Security Center (DSC) to grant DSC the permissions to access data assets in other services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81970', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'This parameter is deprecated.', + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '2', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HasPermission' => [ + 'description' => 'Indicates whether the service-linked role was created. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1EBF271', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HasPermission\\": true,\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1EBF271\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSlrRoleResponse>\\n <HasPermission>true</HasPermission>\\n <RequestId>208B016D-4CB9-4A85-96A5-0B8ED1EBF271</RequestId>\\n</CreateSlrRoleResponse>","errorExample":""}]', + 'title' => 'CreateSlrRole', + 'description' => 'You can call this operation to allow DSC to access the data assets in services such as Object Storage Service (OSS), ApsaraDB RDS, and MaxCompute. After you call this operation, the system automatically creates a service-linked role named AliyunServiceRoleForSDDP and attaches the AliyunServiceRolePolicyForSDDP policy to the role.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDataLimit' => [ + 'summary' => 'Revokes the scan permissions on a data asset. The data asset can be a database, an instance, or a bucket.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81976', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data asset.'."\n" + ."\n" + .'You can call the DescribeDataLimits operation to query the IDs of data assets. The value of the Id response parameter indicates the ID of a data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12033', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '1', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'This parameter is deprecated.', + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B695EF1', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteDataLimit>\\r\\n\\t<RequestId>7C3AC882-E5A8-4855-BE77-B6837B695EF1</RequestId>\\r\\n</DeleteDataLimit>\\t\\r\\n","errorExample":""}]', + 'title' => 'DeleteDataLimit', + 'description' => 'You can call this operation to revoke the permissions on a data asset from Data Security Center (DSC).'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDataLimits' => [ + 'summary' => 'Queries the data assets such as instances, databases, or buckets that Data Security Center (DSC) is authorized to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82013', + 'abilityTreeNodes' => [ + 'FEATUREsddpXMFUF8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service to which the data asset belongs. This parameter is required. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: Object Storage Service (OSS)'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n" + .'* **6**: self-managed database'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parent ID of the data asset to be queried. Valid values:'."\n" + ."\n" + .'* The name or ID of the MaxCompute project.'."\n" + .'* The name or ID of the OSS bucket.'."\n" + .'* The name or ID of the ApsaraDB RDS instance or database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1112', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the data asset resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CheckStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data detection status. Valid values:'."\n" + ."\n" + .'* **0**: The data detection is ready.'."\n" + .'* **1**: The data detection is running.'."\n" + .'* **2**: The connectivity test is in progress.'."\n" + .'* **3**: The connectivity test passed.'."\n" + .'* **4**: The connectivity test failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the security audit feature. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine. Valid values include **MySQL**, **SQLServer**, **Oracle**, **PostgreSQL**, and **MongoDB**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DatamaskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether DSC has the data de-identification permissions on the data asset. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether DSC has the data detection permissions on the data asset. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1616068534877', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1616068534877', + ], + ], + [ + 'name' => 'MemberAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '**********8103', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989***', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Items' => [ + 'description' => 'The data assets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'SupportEvent' => [ + 'description' => 'Indicates whether anomalous event detection is supported. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => 'The reason for the failure.'."\n", + 'type' => 'string', + 'example' => 'The password is invalid.'."\n", + ], + 'CheckStatus' => [ + 'description' => 'The data detection status. Valid values:'."\n" + ."\n" + .'* **0**: The data detection is ready.'."\n" + .'* **1**: The data detection is running.'."\n" + .'* **2**: The connectivity test is in progress.'."\n" + .'* **3**: The connectivity test is passed.'."\n" + .'* **4**: The connectivity test failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'LocalName' => [ + 'description' => 'The region in which the data asset resides.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'TenantName' => [ + 'description' => 'The alias of the tenant.'."\n", + 'type' => 'string', + 'example' => 'insta_gram', + ], + 'NextStartTime' => [ + 'description' => 'The next time when the data asset is scanned. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676620236000', + ], + 'Port' => [ + 'description' => 'The port number of the self-managed database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'CheckStatusName' => [ + 'description' => 'The name of the data detection status.'."\n", + 'type' => 'string', + 'example' => 'Connectivity test status'."\n", + ], + 'SamplingSize' => [ + 'description' => 'The number of sensitive data samples. Valid values: **0**, **5**, and **10**. Unit: data entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ParentId' => [ + 'description' => 'The parent ID of the data asset that you want to query. Valid values include **bucket, db, and project**.'."\n", + 'type' => 'string', + 'example' => 'project', + ], + 'DatamaskStatus' => [ + 'description' => 'Indicates whether DSC has the data de-identification permissions on the data asset. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProcessTotalCount' => [ + 'description' => 'The total number of data tables or files.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ResourceType' => [ + 'description' => 'The type of the service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n" + .'* **6**: self-managed database'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'connect_network_error', + ], + 'OcrStatus' => [ + 'description' => 'Indicates whether the optical character recognition (OCR) feature is enabled. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LogStoreDay' => [ + 'description' => 'The retention period of raw logs. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'EventStatus' => [ + 'description' => 'Indicates whether the data leak prevention feature is enabled. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes (default)'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SupportScan' => [ + 'description' => 'Indicates whether the data asset scan feature is supported. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LastFinishedTime' => [ + 'description' => 'The time when the last scan is performed.'."\n" + ."\n" + .'* The value is a UNIX timestamp.'."\n" + .'* Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '145600000', + ], + 'UserName' => [ + 'description' => 'The username that is used to access the data asset.'."\n", + 'type' => 'string', + 'example' => 'tsts', + ], + 'AuditStatus' => [ + 'description' => 'Indicates whether the security audit feature is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SupportOcr' => [ + 'description' => 'Indicates whether OCR is supported. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EngineType' => [ + 'description' => 'The type of the database engine. Valid values include **MySQL**, **SQLServer**, **Oracle**, **PostgreSQL**, and **MongoDB**.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'InstanceId' => [ + 'description' => 'The ID of the data asset to which the table belongs.'."\n", + 'type' => 'string', + 'example' => '12332', + ], + 'TotalCount' => [ + 'description' => 'The total number of fields in the table.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'DbVersion' => [ + 'description' => 'The database engine version.'."\n", + 'type' => 'string', + 'example' => '2.0', + ], + 'RegionId' => [ + 'description' => 'The region in which the asset resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => 'The time when the data asset was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '145600000', + ], + 'SupportAudit' => [ + 'description' => 'Indicates whether the security audit feature is supported. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AutoScan' => [ + 'description' => 'Indicates whether the data asset can be automatically scanned. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResourceTypeCode' => [ + 'description' => 'The code of the service to which the data asset belongs. Valid values: **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'SupportDatamask' => [ + 'description' => 'Indicates whether the data de-identification feature is supported. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProcessStatus' => [ + 'description' => 'The status of the data asset scan. Valid values:'."\n" + ."\n" + .'* **-1**: invalid'."\n" + .'* **0**: waiting'."\n" + .'* **1**: being scanned'."\n" + .'* **2**: suspended'."\n" + .'* **3**: completed'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Id' => [ + 'description' => 'The unique ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Enable' => [ + 'description' => 'Indicates whether DSC has the data identification permissions on the data asset. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityGroupIdList' => [ + 'description' => 'A list of the IDs of the security groups that are used by PrivateLink when you install the DSC agent.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the security group that is used by PrivateLink when you install the DSC agent.'."\n", + 'type' => 'string', + 'example' => 'sg-bp113yf20quxkvy****', + ], + ], + 'VSwitchIdList' => [ + 'description' => 'A list of the IDs of the vSwitches that are used by PrivateLink when you install the DSC agent.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the vSwitch that is used by PrivateLink when you install the DSC agent.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1kk2mtrtey7o4ju****', + ], + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the data asset belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-2zevcqke6hh09c41****', + ], + 'MemberAccount' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '**********8103'."\n", + ], + 'LastStartTime' => [ + 'description' => 'The last scan start time of data assets, in milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '145600000', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989***\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 200,\\n \\"Items\\": [\\n {\\n \\"SupportEvent\\": true,\\n \\"ErrorMessage\\": \\"密码不正确\\",\\n \\"CheckStatus\\": 3,\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"TenantName\\": \\"insta_gram\\",\\n \\"NextStartTime\\": 1676620236000,\\n \\"Port\\": 3306,\\n \\"CheckStatusName\\": \\"联通性检测状态\\",\\n \\"SamplingSize\\": 5,\\n \\"ParentId\\": \\"project\\",\\n \\"DatamaskStatus\\": 1,\\n \\"ProcessTotalCount\\": 100,\\n \\"ResourceType\\": 5,\\n \\"ErrorCode\\": \\"connect_network_error\\",\\n \\"OcrStatus\\": 1,\\n \\"LogStoreDay\\": 30,\\n \\"EventStatus\\": 1,\\n \\"SupportScan\\": true,\\n \\"LastFinishedTime\\": 145600000,\\n \\"UserName\\": \\"tsts\\",\\n \\"AuditStatus\\": 1,\\n \\"SupportOcr\\": true,\\n \\"EngineType\\": \\"MySQL\\",\\n \\"InstanceId\\": \\"12332\\",\\n \\"TotalCount\\": 100,\\n \\"InstanceDescription\\": \\"123\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 145600000,\\n \\"SupportAudit\\": true,\\n \\"AutoScan\\": 1,\\n \\"ResourceTypeCode\\": \\"RDS\\",\\n \\"SupportDatamask\\": true,\\n \\"ProcessStatus\\": 3,\\n \\"Id\\": 1,\\n \\"Enable\\": 1,\\n \\"SecurityGroupIdList\\": [\\n \\"sg-bp113yf20quxkvy****\\"\\n ],\\n \\"VSwitchIdList\\": [\\n \\"vsw-bp1kk2mtrtey7o4ju****\\"\\n ],\\n \\"VpcId\\": \\"vpc-2zevcqke6hh09c41****\\",\\n \\"MemberAccount\\": 0,\\n \\"LastStartTime\\": 145600000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataLimitsResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989***</RequestId>\\n <PageSize>10</PageSize>\\n <TotalCount>200</TotalCount>\\n <Items>\\n <SupportEvent>true</SupportEvent>\\n <ErrorMessage>密码不正确</ErrorMessage>\\n <CheckStatus>3</CheckStatus>\\n <LocalName>华东1（杭州）</LocalName>\\n <TenantName>insta_gram</TenantName>\\n <NextStartTime>145600000</NextStartTime>\\n <Port>3306</Port>\\n <CheckStatusName>联通性检测状态</CheckStatusName>\\n <SamplingSize>5</SamplingSize>\\n <ParentId>project</ParentId>\\n <DatamaskStatus>1</DatamaskStatus>\\n <ProcessTotalCount>100</ProcessTotalCount>\\n <ErrorCode>connect_network_error</ErrorCode>\\n <OcrStatus>1</OcrStatus>\\n <LogStoreDay>30</LogStoreDay>\\n <EventStatus>1</EventStatus>\\n <SupportScan>true</SupportScan>\\n <LastFinishedTime>145600000</LastFinishedTime>\\n <UserName>tsts</UserName>\\n <AuditStatus>1</AuditStatus>\\n <SupportOcr>true</SupportOcr>\\n <EngineType>MySQL</EngineType>\\n <InstanceId>12332</InstanceId>\\n <TotalCount>100</TotalCount>\\n <InstanceDescription>123</InstanceDescription>\\n <DbVersion>2.0</DbVersion>\\n <RegionId>cn-hangzhou</RegionId>\\n <GmtCreate>145600000</GmtCreate>\\n <SupportAudit>true</SupportAudit>\\n <AutoScan>1</AutoScan>\\n <ResourceTypeCode>RDS</ResourceTypeCode>\\n <SupportDatamask>true</SupportDatamask>\\n <ProcessStatus>3</ProcessStatus>\\n <Id>1</Id>\\n <Enable>1</Enable>\\n </Items>\\n</DescribeDataLimitsResponse>","errorExample":""}]', + 'title' => 'DescribeDataLimits', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDataLimit' => [ + 'summary' => 'Modifies configuration items for a data asset that you authorize Data Security Center (DSC) to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82106', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the data asset for which you want to modify configuration items.'."\n" + ."\n" + .'> You can call the [DescribeDataLimits](~~DescribeDataLimits~~) operation to query the ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: Object Storage Service (OSS)'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the data asset resides. Valid values:'."\n" + ."\n" + .'* **cn-beijing**: China (Beijing)'."\n" + .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" + .'* **cn-huhehaote**: China (Hohhot)'."\n" + .'* **cn-hangzhou**: China (Hangzhou)'."\n" + .'* **cn-shanghai**: China (Shanghai)'."\n" + .'* **cn-shenzhen**: China (Shenzhen)'."\n" + .'* **cn-hongkong**: China (Hong Kong)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username used to log on to the ApsaraDB RDS database that you authorize DSC to access.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'User01', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password used to log on to the ApsaraDB RDS database that you authorize DSC to access.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'ModifyPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to change the username and password that are used to log on to the ApsaraDB RDS database. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the security audit feature. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'LogStoreDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of raw logs after you enable the security audit feature. Unit: days. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **90**'."\n" + .'* **180**'."\n" + .'* **365**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine that is run by the instance. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **SQLServer**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port that is used to connect to the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'AutoScan', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically trigger a re-scan after a rule is modified. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n" + ."\n" + .'> When a re-scan is triggered, DSC scans all data in your data asset.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SamplingSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of sensitive data samples tht are collected after sensitive data detection is enabled. Valid values:'."\n" + ."\n" + .'* **0**'."\n" + .'* **5**'."\n" + .'* **10**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the data asset belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zevcqke6hh09c41****', + ], + ], + [ + 'name' => 'SecurityGroupIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The security group that is used by PrivateLink when you install the DSC agent.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp113yf20quxkvy****', + 'description' => 'The security group ID that is used by PrivateLink when you install the DSC agent.', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'VSwitchIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The vSwitch that is used by PrivateLink when you install the DSC agent.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1kk2mtrtey7o4ju****', + 'description' => 'The vSwitch ID that is used by PrivateLink when you install the DSC agent.', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B695EF1', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDataLimitResponse>\\n <RequestId>7C3AC882-E5A8-4855-BE77-B6837B695EF1</RequestId>\\n</ModifyDataLimitResponse>","errorExample":""}]', + 'title' => 'ModifyDataLimit', + ], + 'DescribeDataLimitDetail' => [ + 'summary' => 'Queries the details of a data asset, such as a MaxCompute project, an ApsaraDB RDS database, or an Object Storage Service (OSS) bucket, that you authorize Data Security Center (DSC) to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82011', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Simplified Chinese.'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the data asset that you want to query.'."\n" + ."\n" + .'> You can call the [DescribeDataLimits](~~DescribeDataLimits~~) operation to query the ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12300', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the data asset that you want to query. Valid values:'."\n" + ."\n" + .'* **1**: virtual private cloud (VPC)'."\n" + .'* **2**: classic network'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'DataLimit' => [ + 'description' => 'The details of the data asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => 'The region in which the data asset resides.'."\n", + 'type' => 'string', + 'example' => 'China (Qingdao)'."\n", + ], + 'CheckStatus' => [ + 'description' => 'The status of the connectivity test between the data asset and DSC. Valid values:'."\n" + ."\n" + .'* **2**: indicates that the data asset was being connected.'."\n" + .'* **3**: indicates that the data asset was connected to DSC.'."\n" + .'* **4**: indicates that the data asset failed to be connected.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Port' => [ + 'description' => 'The port number that is used to connect to the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'CheckStatusName' => [ + 'description' => 'The result that indicates the status of the connectivity test between the data asset and DSC. Valid values:'."\n" + ."\n" + .'* **Passed**'."\n" + .'* **Failed**'."\n" + .'* **Testing**'."\n", + 'type' => 'string', + 'example' => 'Passed'."\n", + ], + 'RegionId' => [ + 'description' => 'The ID of the region in which the data asset resides.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'ParentId' => [ + 'description' => 'The ID and name of the data asset in the service to which the data asset belongs.'."\n", + 'type' => 'string', + 'example' => 'rm-m5eup49p6o274****.RDS_example', + ], + 'ResourceType' => [ + 'description' => 'The type of the service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => 'The time when the data asset was connected to DSC. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '145600000', + ], + 'ResourceTypeCode' => [ + 'description' => 'The service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **MaxCompute**'."\n" + .'* **OSS**'."\n" + .'* **ADS**'."\n" + .'* **OTS**'."\n" + .'* **RDS**'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'UserName' => [ + 'description' => 'The account of the user who manages the data asset.'."\n", + 'type' => 'string', + 'example' => 'User01', + ], + 'Id' => [ + 'description' => 'The ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12300', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"DataLimit\\": {\\n \\"LocalName\\": \\"华北1（青岛）\\",\\n \\"CheckStatus\\": 3,\\n \\"Port\\": 3306,\\n \\"CheckStatusName\\": \\"通过\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ParentId\\": \\"rm-m5eup49p6o274****.RDS_example\\",\\n \\"ResourceType\\": 1,\\n \\"GmtCreate\\": 145600000,\\n \\"ResourceTypeCode\\": \\"RDS\\",\\n \\"UserName\\": \\"User01\\",\\n \\"Id\\": 12300\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataLimitDetailResponse>\\n <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n <DataLimit>\\n <LocalName>华北1（青岛）</LocalName>\\n <CheckStatus>3</CheckStatus>\\n <Port>3306</Port>\\n <CheckStatusName>通过</CheckStatusName>\\n <RegionId>cn-qingdao</RegionId>\\n <ParentId>rm-m5eup49p6o274****.RDS_example</ParentId>\\n <ResourceType>1</ResourceType>\\n <GmtCreate>145600000</GmtCreate>\\n <ResourceTypeCode>RDS</ResourceTypeCode>\\n <UserName>User01</UserName>\\n <Id>12300</Id>\\n </DataLimit>\\n</DescribeDataLimitDetailResponse>","errorExample":""}]', + 'title' => 'DescribeDataLimitDetail', + 'description' => "\n" + ."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDataLimit' => [ + 'summary' => 'Authorizes Data Security Center (DSC) to scan data assets. The data assets can be a database, a project, or a bucket.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81960', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1** :MaxCompute'."\n" + .'* **2**: Object Storage Service (OSS)'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4** :Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the data asset resides. Valid values:'."\n" + ."\n" + .'* **cn-beijing**: China (Beijing).'."\n" + .'* **cn-zhangjiakou**: China (Zhangjiakou)'."\n" + .'* **cn-huhehaote**: China (Hohhot)'."\n" + .'* **cn-hangzhou**: China (Hangzhou)'."\n" + .'* **cn-shanghai**: China (Shanghai)'."\n" + .'* **cn-shenzhen**: China (Shenzhen)'."\n" + .'* **cn-hongkong**: China (Hong Kong)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the asset. The value is a connection string. It consists of an instance ID and a database name, which are separated by a comma (,). This parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-11**', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username that is used to access the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yhm', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that is used to access the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'passwd', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the security audit feature. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoScan', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically trigger a re-scan after a rule is modified. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n" + ."\n" + .'> When a re-scan is triggered, DSC scans all data in your data asset.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'LogStoreDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of raw logs after you enable the security audit feature. Unit: days. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **90**'."\n" + .'* **180**'."\n" + .'* **365**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine that is run by the instance. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **SQLServer**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port that is used to connect to the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'OcrStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable optical character recognition (OCR). Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EventStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable anomalous event detection. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes (default)'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable sensitive data detection. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n" + ."\n" + .'> If this is your first time to authorize DSC to access the data asset, the default value is 1. If this is not your first time to authorize DSC to access the data asset, the default value is the same as that used in the last authorization operation. Both 1 and 0 are possible.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SamplingSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of sensitive data samples that are collected after sensitive data detection is enabled. Valid values:'."\n" + ."\n" + .'* **0**'."\n" + .'* **5**'."\n" + .'* **10**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CertificatePermission', + 'in' => 'query', + 'schema' => [ + 'description' => 'The permissions. Valid values:'."\n" + ."\n" + .'* **ReadOnly**: read-only permissions'."\n" + .'* **ReadWrite**: read and write permissions'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadOnly', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'string', + 'required' => false, + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'InstantlyScan', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to immediately scan the authorized asset. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B695EF1', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDataLimitResponse>\\n<Id>1</Id>\\n<RequestId>7C3AC882-E5A8-4855-BE77-B6837B695EF1</RequestId>\\n</CreateDataLimitResponse>","errorExample":""}]', + 'title' => 'CreateDataLimit', + 'description' => 'You can call this operation to authorize DSC to scan data assets to ensure the security of the data assets.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDataLimitSet' => [ + 'summary' => 'Queries assets that Data Security Center (DSC) is authorized to scan, or the regions that DSC supports.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82014', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese (default)'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parent asset ID of the data asset.'."\n" + ."\n" + .'You can call the [DescribeDataLimitDetail](~~DescribeDataLimitDetail~~) or [DescribeDataLimits](~~DescribeDataLimits~~) operation to obtain the parent asset ID of the data asset from the value of the **ParentId** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '2', + ], + ], + [ + 'name' => 'RegionType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'DataLimitSet' => [ + 'description' => 'The information about the data asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceTypeCode' => [ + 'description' => 'The service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **ODPS**'."\n" + .'* **OSS**'."\n" + .'* **ADS**'."\n" + .'* **OTS**'."\n" + .'* **RDS**'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'ResourceType' => [ + 'description' => 'The type of service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => 'The total number of data objects in the data assets.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DataLimitList' => [ + 'description' => 'An array that consists of data assets that DSC is authorized to scan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => 'The region in which the data asset resides.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'CheckStatus' => [ + 'description' => 'Indicates whether the test of connectivity between DSC and the data asset is passed.'."\n" + ."\n" + .'* **2**: The connectivity test is in progress.'."\n" + .'* **3**: The connectivity test is passed.'."\n" + .'* **4**: The connectivity test failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Connector' => [ + 'description' => 'The connection string that is used to access the data asset.'."\n", + 'type' => 'string', + 'example' => 'Connection string'."\n", + ], + 'CheckStatusName' => [ + 'description' => 'The name of the data detection status.'."\n", + 'type' => 'string', + 'example' => 'Connectivity test status'."\n", + ], + 'RegionId' => [ + 'description' => 'The region in which the data asset resides.'."\n", + 'type' => 'string', + 'example' => 'cn-****', + ], + 'ParentId' => [ + 'description' => 'The parent asset ID of the data asset.'."\n", + 'type' => 'string', + 'example' => 'db', + ], + 'ResourceType' => [ + 'description' => 'The type of service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'GmtCreate' => [ + 'description' => 'The time when the data asset was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1625587423000', + ], + 'ResourceTypeCode' => [ + 'description' => 'The code of the service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **ODPS**'."\n" + .'* **OSS**'."\n" + .'* **ADS**'."\n" + .'* **OTS**'."\n" + .'* **RDS**'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'UserName' => [ + 'description' => 'The username that is used to access the data asset.'."\n", + 'type' => 'string', + 'example' => 'tsts', + ], + 'Id' => [ + 'description' => 'The ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'OssBucketList' => [ + 'description' => 'An array consisting of the OSS objects that DSC is authorized to scan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'cn-****', + ], + 'BucketName' => [ + 'description' => 'The name of the OSS bucket to which the OSS object belongs.'."\n", + 'type' => 'string', + 'example' => 'oss-bucket', + ], + ], + ], + ], + 'RegionList' => [ + 'description' => 'An array consisting of the regions in which the data assets can be scanned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-****', + ], + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"DataLimitSet\\": {\\n \\"ResourceTypeCode\\": \\"OSS\\",\\n \\"ResourceType\\": 2,\\n \\"TotalCount\\": 10,\\n \\"DataLimitList\\": [\\n {\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"CheckStatus\\": 3,\\n \\"Connector\\": \\"连接串\\",\\n \\"CheckStatusName\\": \\"联通性检测状态\\",\\n \\"RegionId\\": \\"cn-****\\",\\n \\"ParentId\\": \\"db\\",\\n \\"ResourceType\\": 2,\\n \\"GmtCreate\\": 1625587423000,\\n \\"ResourceTypeCode\\": \\"OSS\\",\\n \\"UserName\\": \\"tsts\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"OssBucketList\\": [\\n {\\n \\"RegionId\\": \\"cn-****\\",\\n \\"BucketName\\": \\"oss-bucket\\"\\n }\\n ],\\n \\"RegionList\\": [\\n {\\n \\"RegionId\\": \\"cn-****\\",\\n \\"LocalName\\": \\"杭州\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataLimitSetResponse>\\n<DataLimitSet>\\n\\t\\t<TotalCount>10</TotalCount>\\n\\t\\t<ResourceTypeCode>OSS</ResourceTypeCode>\\n\\t\\t<ResourceType>2</ResourceType>\\n\\t\\t<DataLimitList>\\n\\t\\t\\t<ParentId>db</ParentId>\\n\\t\\t\\t<Connector>连接串</Connector>\\n\\t\\t\\t<GmtCreate>1625587423000</GmtCreate>\\n\\t\\t\\t<UserName>tsts</UserName>\\n\\t\\t\\t<ResourceTypeCode>OSS</ResourceTypeCode>\\n\\t\\t\\t<CheckStatus>3</CheckStatus>\\n\\t\\t\\t<ResourceType>2</ResourceType>\\n\\t\\t\\t<Id>1</Id>\\n\\t\\t\\t<RegionId>cn-****</RegionId>\\n\\t\\t\\t<CheckStatusName>联通性检测状态</CheckStatusName>\\n\\t\\t\\t<LocalName>华东1（杭州）</LocalName>\\n\\t\\t</DataLimitList>\\n\\t\\t<OssBucketList>\\n\\t\\t\\t<BucketName>oss-bucket</BucketName>\\n\\t\\t\\t<RegionId>cn-****</RegionId>\\n\\t\\t</OssBucketList>\\n\\t\\t<RegionList>\\n\\t\\t\\t<RegionId>cn-****</RegionId>\\n\\t\\t\\t<LocalName>杭州</LocalName>\\n\\t\\t</RegionList>\\n</DataLimitSet>\\n<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n</DescribeDataLimitSetResponse>","errorExample":""}]', + 'title' => 'DescribeDataLimitSet', + 'description' => 'You can call this operation to query the data assets that are authorized to be scanned. This facilitates resource search and aggregation.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSources' => [ + 'summary' => 'Queries a list of data assets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82049', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese (default)'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the data asset resides. For more information, see [Supported regions](~~214257~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine type. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **MariaDB**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + .'* **SQLServer**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance-demo-****', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: Object Storage Service (OSS)'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore (OTS)'."\n" + .'* **5**: ApsaraDB RDS'."\n" + .'* **6**: self-managed databases'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which the data asset to query belongs. Valid values: **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the security audit feature. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SearchType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data asset type based on which a fuzzy search is performed.'."\n" + ."\n" + .'* **InstanceId**: the ID of the instance.'."\n" + .'* **InstanceName**: the name of the instance.'."\n" + .'* **DatabaseName**: the name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'InstanceId', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content based on which a fuzzy search is performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AuthStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether DSC is authorized to access the data asset.'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '5A7E8FB9-5011-5A90-97D9-AE587047****', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Items' => [ + 'description' => 'The assets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'LastModifyUserId' => [ + 'description' => 'The ID of the account that is last used to modify the data asset.'."\n", + 'type' => 'string', + 'example' => 'demo', + ], + 'PasswordStatus' => [ + 'description' => 'Indicates whether the password is used. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EngineType' => [ + 'description' => 'The engine type. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **MariaDB**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + .'* **SQLServer**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'rm-****', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'Test'."\n", + ], + 'RegionId' => [ + 'description' => 'The ID of the region where the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DbName' => [ + 'description' => 'The name of the database to which the data asset belongs.'."\n", + 'type' => 'string', + 'example' => 'demo', + ], + 'LastModifyTime' => [ + 'description' => 'The time when the data asset was last modified. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1625587423000', + ], + 'RegionName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'CanModifyUserName' => [ + 'description' => 'Indicates whether the username and password can be changed. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LogStoreDay' => [ + 'description' => 'The retention period of raw logs. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'GmtCreate' => [ + 'description' => 'The time when the data asset was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1625587423000', + ], + 'AutoScan' => [ + 'description' => 'Indicates whether the automatic scan feature is enabled to detect sensitive data. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProductId' => [ + 'description' => 'The ID of the service to which the asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: OTS'."\n" + .'* **5**: ApsaraDB RDS'."\n" + .'* **6**: self-managed databases'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'InstanceSize' => [ + 'description' => 'The storage space size of the instance. This parameter is valid only if the value of the ProductId parameter is 2. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '409600', + ], + 'UserName' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'User01', + ], + 'AuditStatus' => [ + 'description' => 'Indicates whether the security audit feature is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Id' => [ + 'description' => 'The unique ID of the data asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TenantId' => [ + 'description' => 'The ID of the tenant.'."\n", + 'type' => 'string', + 'example' => '11', + ], + 'Enable' => [ + 'description' => 'Indicates whether sensitive data detection is enabled for the data asset. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckStatus' => [ + 'description' => 'The data detection status. Valid values:'."\n" + ."\n" + .'* **0**: The data detection is ready.'."\n" + .'* **1**: The data detection is running.'."\n" + .'* **2**: The connectivity test is in progress.'."\n" + .'* **3**: The connectivity test passed.'."\n" + .'* **4**: The connectivity test failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'DatamaskStatus' => [ + 'description' => 'Indicates whether DSC has the data de-identification permissions on the data asset. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => 'The reason for the failure.'."\n", + 'type' => 'string', + 'example' => 'The password is invalid.'."\n", + ], + 'SamplingSize' => [ + 'description' => 'The number of sensitive data samples. Valid values: **0**, **5**, and **10**. Unit: data entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"5A7E8FB9-5011-5A90-97D9-AE587047****\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"LastModifyUserId\\": \\"demo\\",\\n \\"PasswordStatus\\": 1,\\n \\"EngineType\\": \\"MySQL\\",\\n \\"TenantName\\": \\"user1\\",\\n \\"InstanceId\\": \\"rm-****\\",\\n \\"InstanceDescription\\": \\"测试使用\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DbName\\": \\"demo\\",\\n \\"LastModifyTime\\": 1625587423000,\\n \\"RegionName\\": \\"杭州\\",\\n \\"CanModifyUserName\\": true,\\n \\"LogStoreDay\\": 30,\\n \\"GmtCreate\\": 1625587423000,\\n \\"AutoScan\\": 0,\\n \\"ProductId\\": 2,\\n \\"InstanceSize\\": 409600,\\n \\"UserName\\": \\"User01\\",\\n \\"AuditStatus\\": 1,\\n \\"Id\\": 1,\\n \\"TenantId\\": \\"11\\",\\n \\"Enable\\": 1,\\n \\"CheckStatus\\": 3,\\n \\"DatamaskStatus\\": 1,\\n \\"ErrorMessage\\": \\"password error\\",\\n \\"SamplingSize\\": 10\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceSourcesResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>5A7E8FB9-5011-5A90-97D9-AE587047DA6C</RequestId>\\n <PageSize>10</PageSize>\\n <TotalCount>2</TotalCount>\\n <Items>\\n <LastModifyUserId>demo</LastModifyUserId>\\n <PasswordStatus>1</PasswordStatus>\\n <EngineType>MySQL</EngineType>\\n <TenantName>user1</TenantName>\\n <InstanceId>rm-****</InstanceId>\\n <InstanceDescription>测试使用</InstanceDescription>\\n <RegionId>cn-hangzhou</RegionId>\\n <DbName>demo</DbName>\\n <LastModifyTime>1625587423000</LastModifyTime>\\n <RegionName>杭州</RegionName>\\n <CanModifyUserName>true</CanModifyUserName>\\n <LogStoreDay>30</LogStoreDay>\\n <GmtCreate>1625587423000</GmtCreate>\\n <AutoScan>0</AutoScan>\\n <ProductId>2</ProductId>\\n <InstanceSize>409600</InstanceSize>\\n <UserName>User01</UserName>\\n <AuditStatus>1</AuditStatus>\\n <Id>1</Id>\\n <TenantId>11</TenantId>\\n <Enable>1</Enable>\\n </Items>\\n</DescribeInstanceSourcesResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceSources', + 'description' => 'You can query a list of unauthorized or authorized data assets based on the value of AuthStatus.'."\n" + ."\n" + .'This operation is no longer used for the KMS console of the new version.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParentInstance' => [ + 'summary' => 'Gets the list of first-level authorizations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '149789', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the number of rows per page. Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the asset is located. Values:'."\n" + .'- **cn-beijing**: China (Beijing)'."\n" + .'- **cn-zhangjiakou**: China (Zhangjiakou)'."\n" + .'- **cn-huhehaote**: China (Hohhot)'."\n" + .'- **cn-hangzhou**: China (Hangzhou)'."\n" + .'- **cn-shanghai**: China (Shanghai)'."\n" + .'- **cn-shenzhen**: China (Shenzhen)'."\n" + .'- **cn-hongkong**: China (Hong Kong)', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Engine type. Values:'."\n" + .'- **MySQL**'."\n" + .'- **MariaDB**'."\n" + .'- **Oracle**'."\n" + .'- **PostgreSQL**'."\n" + .'- **SQLServer**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID to which the data in the data asset table belongs.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-*******xx', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database name.', + 'type' => 'string', + 'required' => false, + 'example' => 'db_**t', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product type. Valid values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SelfDB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'CheckStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Connection status of the instance or the database under the instance. Values:'."\n" + .'- **-3**: Database not created'."\n" + .'- **-2**: Released'."\n" + .'- **-1**: Not connected'."\n" + .'- **2**: Connectivity test in progress'."\n" + .'- **3**: Connected'."\n" + .'- **4**: Connection failed', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance status.'."\n" + .'- **Running**: Running'."\n" + .'- **Released**: Released'."\n" + .'- **DatabaseNotCreated**: Database not created', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'AuthStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authorization status of the data asset instance.'."\n" + .'- **0**: Unauthorized'."\n" + .'- **1**: Authorized', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MemberAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Member account ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '**********8103', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Language type for request and response messages. Values:'."\n" + .'- **zh_cn**: Default, Simplified Chinese'."\n" + .'- **en_us**: English (US)', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID of the result.', + 'type' => 'string', + 'example' => 'ACEF9334-BB50-525D-8CF3-6CF504E4D1B3', + ], + 'CurrentPage' => [ + 'description' => 'When performing a paginated query, set the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'When performing a paginated query, set the maximum number of data asset instances displayed per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'Total number of data items in the result.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Items' => [ + 'description' => 'The assets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => 'rm-*******t2vz', + ], + 'LocalName' => [ + 'description' => 'Region name. The values are as follows:'."\n" + ."\n" + .'- **China (Hangzhou)**'."\n" + .'- **China (Shanghai)**'."\n" + .'- **China (Beijing)**'."\n" + .'- **China (Zhangjiakou)**'."\n" + .'- **China (Shenzhen)**'."\n" + .'- **China (Guangzhou)**'."\n" + .'- **China (Hong Kong)**'."\n" + .'- **Singapore**'."\n" + .'- **US (Silicon Valley)**', + 'type' => 'string', + 'example' => 'China (Hangzhou)', + ], + 'EngineType' => [ + 'description' => 'The engine type. Valid values:'."\n" + .'- **MySQL**'."\n" + .'- **MariaDB**'."\n" + .'- **Oracle**'."\n" + .'- **PostgreSQL**'."\n" + .'- **SQLServer**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'ParentId' => [ + 'description' => 'Identifier for the authorized asset. For structured data, it is identified by `instanceID.databaseName`.', + 'type' => 'string', + 'example' => 'rm-******xxx.**st', + ], + 'DbNum' => [ + 'description' => 'Number of databases under the instance.', + 'type' => 'string', + 'example' => '3', + ], + 'ClusterStatus' => [ + 'description' => 'Instance status.', + 'type' => 'string', + 'example' => 'Running', + ], + 'TenantId' => [ + 'description' => 'Tenant ID, valid only for OceanBase assets.', + 'type' => 'string', + 'example' => 'HB***-zh_CN', + ], + 'TenantName' => [ + 'description' => 'Tenant name, valid only for OceanBase assets.', + 'type' => 'string', + 'example' => 'user1', + ], + 'InstanceDescription' => [ + 'description' => 'Description of the instance.', + 'type' => 'string', + 'example' => 'instance description', + ], + 'ResourceType' => [ + 'description' => 'Asset type name. The values are as follows:'."\n" + .'- **MaxCompute**'."\n" + .'- **OSS**'."\n" + .'- **ADB-MYSQL**'."\n" + .'- **TableStore**'."\n" + .'- **RDS**'."\n" + .'- **SelfDB**'."\n" + .'- **PolarDB-X**'."\n" + .'- **PolarDB**'."\n" + .'- **ADB-PG**'."\n" + .'- **OceanBase**'."\n" + .'- **MongoDB**'."\n" + .'- **Redis**', + 'type' => 'string', + 'example' => 'RDS', + ], + 'UnConnectDbCount' => [ + 'description' => 'Number of unconnected databases under the instance.', + 'type' => 'string', + 'example' => '1', + ], + 'UnSupportOneClickAuthReason' => [ + 'description' => 'Reason for not supporting one-click authorization.', + 'type' => 'string', + 'example' => 'engine type not support', + ], + 'ConnectNode' => [ + 'description' => 'Connection node type, valid only for MongoDB assets.', + 'type' => 'string', + 'example' => 'Primary', + ], + 'SupportConnectNodes' => [ + 'description' => 'Supported connection nodes, separated by commas.', + 'type' => 'string', + 'example' => 'Primary,Secondary', + ], + 'AuthStatus' => [ + 'description' => 'Authorization status of the data asset instance.'."\n" + .'- **0**: Unauthorized'."\n" + .'- **1**: Authorized', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceSize' => [ + 'description' => 'Instance space size, valid only for OSS assets. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '409600', + ], + 'AuditStatus' => [ + 'description' => 'Audit authorization status. The values are as follows:'."\n" + .'- **1**: Authorized'."\n" + .'- **0**: Unauthorized', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MemberAccount' => [ + 'description' => 'Member account ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '**********8103', + ], + 'AuthTime' => [ + 'description' => 'Instance authorization time, in milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1719882941000', + ], + 'RegionId' => [ + 'description' => 'The region in which the asset resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACEF9334-BB50-525D-8CF3-6CF504E4D1B3\\",\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"Items\\": [\\n {\\n \\"InstanceId\\": \\"rm-*******t2vz\\",\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"EngineType\\": \\"MySQL\\",\\n \\"ParentId\\": \\"rm-******xxx.**st\\",\\n \\"DbNum\\": \\"3\\",\\n \\"ClusterStatus\\": \\"Running\\",\\n \\"TenantId\\": \\"HB***-zh_CN\\",\\n \\"TenantName\\": \\"user1\\",\\n \\"InstanceDescription\\": \\"instance description\\",\\n \\"ResourceType\\": \\"RDS\\",\\n \\"UnConnectDbCount\\": \\"1\\",\\n \\"UnSupportOneClickAuthReason\\": \\"engine type not support\\",\\n \\"ConnectNode\\": \\"Primary\\",\\n \\"SupportConnectNodes\\": \\"Primary,Secondary\\",\\n \\"AuthStatus\\": 1,\\n \\"InstanceSize\\": 409600,\\n \\"AuditStatus\\": 1,\\n \\"MemberAccount\\": 0,\\n \\"AuthTime\\": 1719882941000,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeParentInstance', + 'translator' => 'machine', + ], + 'ScanOssObjectV1' => [ + 'summary' => 'Creates an identification task to scan sensitive data in Object Storage Service (OSS) objects.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236601', + 'abilityTreeNodes' => [ + 'FEATUREsddpXMFUF8', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the OSS bucket is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the OSS bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sddp-api-demo-bucket', + ], + ], + [ + 'name' => 'ObjectKeyList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The objects in the OSS bucket that you want to scan. You can specify up to 50 objects at a time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the object in the OSS bucket. You must specify the full path of the object.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dir1/object.txt', + ], + 'required' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the industry-specific classification template.'."\n" + ."\n" + .'> You can call the **DescribeCategoryTemplateList** operation to query industry-specific classification templates. If you do not specify this parameter, the system automatically uses the main template.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B695EF1', + ], + 'Id' => [ + 'description' => 'The ID of the identification task that is returned after the identification task is created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '268', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\",\\n \\"Id\\": 268\\n}","type":"json"}]', + 'title' => 'ScanOssObjectV1', + 'description' => '### [](#)Prerequisites'."\n" + ."\n" + .'To call this operation, make sure that asset authorization for your OSS bucket is complete and the bucket is connected. If the authorization is not complete, the bucket_not_authorized error code is returned when you call the operation.'."\n" + ."\n" + .'### [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n" + ."\n" + .'### [](#)Additional information'."\n" + ."\n" + .'After you call this operation, you can obtain the task ID. You can specify the task ID in the DescribeIdentifyTaskDetail operation to query the state of the task.'."\n" + ."\n" + .'After the task is complete, you can call the DescribeOssObjectDetailV2 operation to query the identification results of sensitive data in the related OSS objects. When you call the DescribeOssObjectDetailV2 operation, you must specify BucketName, ServiceRegionId, and ObjectKey.'."\n", + ], + 'CreateScanTask' => [ + 'summary' => 'Creates a custom scan task. The custom scan task is used to scan data assets on which Data Security Center (DSC) is granted the scan permissions for sensitive data.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81968', + 'abilityTreeNodes' => [ + 'FEATUREsddpXMFUF8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataLimitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the data asset, such as an instance, a database, and a bucket. You can call the [DescribeDataLimits](~~DescribeDataLimits~~) operation to query the unique ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'IntervalDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval between two consecutive custom scan tasks. Unit: days. Valid values: 1 to 2147483648.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'RunHour', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the scan task is executed next time. Unit: hours.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'RunMinute', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the scan task is executed next time. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scan task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'scan-test-sample****', + ], + ], + [ + 'name' => 'TaskUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to create the scan task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo', + ], + ], + [ + 'name' => 'OssScanPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data to be scanned in the Object Storage Service (OSS) bucket. Prefix match, suffix match, and regular expression match are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test/test', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The matching rule that specifies the scan scope of the custom scan task. This parameter takes effect only if you set the **ScanRangeContent** parameter. Valid values:'."\n" + ."\n" + .'* **0**: exact match'."\n" + .'* **1**: prefix match'."\n" + .'* **2**: suffix match'."\n" + .'* **3**: regular expression match'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ScanRangeContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data to be scanned in a structured data asset. Prefix match, suffix match, and regular expression match are supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'datamask/', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service to which the data assets to be scanned belong. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'This parameter is deprecated.', + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the custom scan task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 100,\\n \\"RequestId\\": \\"B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScanTaskResponse>\\n <RequestId>B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0</RequestId>\\n <Id>100</Id>\\n</CreateScanTaskResponse>","errorExample":""}]', + 'title' => 'CreateScanTask', + 'description' => 'You can call this operation to create a custom scan task for authorized data assets. You can customize the interval between two consecutive scan tasks and the time when the scan task is executed next time.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDefaultLevel' => [ + 'summary' => 'Changes the sensitivity levels of sensitive data. You can change the default sensitivity levels of data that cannot be classified as sensitive or insensitive, and the sensitivity levels of data that can be classified as sensitive.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82112', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'DefaultId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default sensitivity level of data that Data Security Center (DSC) cannot classify as sensitive or insensitive. Valid values:'."\n" + ."\n" + .'* **1**: N/A'."\n" + .'* **2**: S1'."\n" + .'* **3**: S2'."\n" + .'* **4**: S3'."\n" + .'* **5**: S4'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'SensitiveIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level ID of data that DSC classifies as sensitive. Separate multiple IDs with commas (,). Valid values:'."\n" + ."\n" + .'* **1**: N/A'."\n" + .'* **2**: S1'."\n" + .'* **3**: S2'."\n" + .'* **4**: S3'."\n" + .'* **5**: S4'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1EBF271', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1EBF271\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyDefaultLevel>\\r\\n\\t<RequestId>208B016D-4CB9-4A85-96A5-0B8ED1EBF271</RequestId>\\r\\n\\t</ModifyDefaultLevel>\\r\\n","errorExample":""}]', + 'title' => 'ModifyDefaultLevel', + 'description' => 'You can call this operation to modify the sensitivity levels of data. This helps you manage the sensitivity levels.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'extraInfo' => ' ', + ], + 'ModifyRuleStatus' => [ + 'summary' => 'Enables or disables a sensitive data detection rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82123', + 'abilityTreeNodes' => [ + 'FEATUREsddpEFXM0Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule.'."\n" + ."\n" + .'> You can query the ID of the sensitive data detection rule by calling the **DescribeRules** operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12341', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'> You can query the ID of the sensitive data detection rule by calling the **DescribeRules** operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable or disable the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: disables the sensitive data detection rule.'."\n" + .'* **1**: enables the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FailedIds' => [ + 'description' => 'The IDs of sensitive data detection rules whose status failed to be changed. Multiple IDs are separated with commas (,).'."\n", + 'type' => 'string', + 'example' => '1,2,3,4', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B695EF1', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FailedIds\\": \\"1,2,3,4\\",\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyRuleStatusResponse>\\n <FailedIds>1,2,3,4</FailedIds>\\n <RequestId>7C3AC882-E5A8-4855-BE77-B6837B695EF1</RequestId>\\n</ModifyRuleStatusResponse>","errorExample":""}]', + 'title' => 'ModifyRuleStatus', + 'extraInfo' => ' ', + ], + 'ModifyRule' => [ + 'summary' => 'Modifies a custom sensitive data detection rule in Data Security Center (DSC).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82121', + 'abilityTreeNodes' => [ + 'FEATUREsddpEFXM0Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule.'."\n" + ."\n" + .'You can call the [DescribeRules](~~DescribeRules~~) operation to obtain the rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the sensitive data detection rule.'."\n" + ."\n" + .'You can call the [DescribeRules](~~DescribeRules~~) operation to obtain the rule name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'esw', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **2**: regular expression'."\n" + .'* **3**: algorithm'."\n" + .'* **5**: keyword'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the sensitive data detection rule. You can specify a regular expression, an algorithm, or keywords that are used to match sensitive fields or text.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '(?:\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\d|1\\\\d{2}|[1-9]\\\\d{1})\\\\.)(?:(?:25[0-5]|2[0-4]\\\\d|[01]?\\\\d?\\\\d)\\\\.){2}(?:25[0-5]|2[0-4]\\\\d|1[0-9]\\\\d|[1-9]\\\\d|[1-9]))(?:\\\\D|$)', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: data detection rule'."\n" + .'* **2**: audit rule'."\n" + .'* **3**: anomalous event detection rule'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service to which the sensitive data detection rule is applied. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the sensitive data detection rule is applied. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'WarnLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The risk level of the alert that is triggered by the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: low level'."\n" + .'* **2**: medium level'."\n" + .'* **3**: high level'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The match type. Valid values:'."\n" + ."\n" + .'* **1**: rule-based match'."\n" + .'* **2**: dictionary-based match'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SupportForm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data assets supported by the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: all data assets'."\n" + .'* **1**: structured data assets'."\n" + .'* **2**: unstructured data assets'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateRuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the templates that are used to audit sensitive data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ModelRuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the models for sensitive data audit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1452', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B695EF1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyRuleResponse>\\n <RequestId>7C3AC882-E5A8-4855-BE77-B6837B695EF1</RequestId>\\n</ModifyRuleResponse>","errorExample":""}]', + 'title' => 'ModifyRule', + 'description' => 'When you call this operation, you must configure request parameters to specify the rule name, rule ID, and rule content.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRule' => [ + 'summary' => 'Deletes a custom sensitive data detection rule from Data Security Center (DSC).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81978', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '122300', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '1', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'This parameter is deprecated.', + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values: **zh** and **en**. The value zh indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C3AC882-E5A8-4855-BE77-B6837B6*****', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B6*****\\"\\n}","type":"json"}]', + 'title' => 'DeleteRule', + ], + 'CreateRule' => [ + 'summary' => 'Creates a custom sensitive data detection rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '81967', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the sensitive data detection rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rule-tst', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: keyword'."\n" + .'* **2**: regular expression'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the sensitive data detection rule. You can specify a regular expression or keywords that are used to match sensitive fields or text.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '(?:\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\d|1\\\\d{2}|[1-9]\\\\d{1})\\\\.)(?:(?:25[0-5]|2[0-4]\\\\d|[01]?\\\\d?\\\\d)\\\\.){2}(?:25[0-5]|2[0-4]\\\\d|1[0-9]\\\\d|[1-9]\\\\d|[1-9]))(?:\\\\D|$)', + ], + ], + [ + 'name' => 'StatExpress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The statistical expression.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: sensitive data detection rule'."\n" + .'* **2**: audit rule'."\n" + .'* **3**: anomalous event detection rule'."\n" + .'* **99**: custom rule'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which data in the column of the table belongs. Valid values include **MaxCompute**, **OSS**, **ADS**, **OTS**, and **RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the data asset belongs. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'WarnLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The risk level of the alert that is triggered. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ID card'."\n", + ], + ], + [ + 'name' => 'ContentCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the content in the sensitive data detection rule. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates attempts to exploit SQL injections. The value 2 indicates bypass by using SQL injections. The value 3 indicates abuse of stored procedures. The value 4 indicates buffer overflow. The value 5 indicates SQL injections based on errors.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service to which the sensitive data detection rule is applied. Valid values include **MaxCompute**, **OSS**, **ADS**, **OTS**, and **RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The match type. Valid values:'."\n" + ."\n" + .'* **1**: rule-based match'."\n" + .'* **2**: dictionary-based match'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SupportForm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the data asset. Valid values:'."\n" + ."\n" + .'* **0**: all data assets'."\n" + .'* **1**: structured data asset'."\n" + .'* **2**: unstructured data asset'."\n" + ."\n" + .'> If you set the parameter to 1 or 2, rules that support all data assets and rules that support the queried data asset type are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'string', + 'required' => false, + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'TemplateRuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the templates that are used to audit sensitive data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ModelRuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the models for sensitive data audit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1452', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The unique ID of the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1EBF271', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1EBF271\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRuleResponse>\\n <Id>1</Id>\\n <RequestId>208B016D-4CB9-4A85-96A5-0B8ED1EBF271</RequestId>\\n</CreateRuleResponse>","errorExample":""}]', + 'title' => 'CreateRule', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRules' => [ + 'summary' => 'Queries sensitive data detection rules.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82070', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: built-in rule'."\n" + .'* **1**: custom rule'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: keyword'."\n" + .'* **2**: regular expression'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the sensitive data detection rule. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '\\*\\*\\* rule'."\n", + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: sensitive data detection rule'."\n" + .'* **2**: audit rule'."\n" + .'* **3**: anomalous event detection rule'."\n" + .'* **99**: custom rule'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The match type. Valid values:'."\n" + ."\n" + .'* 1: rule-based match'."\n" + .'* 2: dictionary-based match'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which the data asset belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the sensitive data detection rule is applied. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'WarnLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The severity level of the alert. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ContentCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the content in the sensitive data detection rule. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates attempts to exploit SQL injections. The value 2 indicates bypass by using SQL injections. The value 3 indicates abuse of stored procedures. The value 4 indicates buffer overflow. The value 5 indicates SQL injections based on errors.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: enabled'."\n" + .'* **0**: disabled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'KeywordCompatible', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to allow earlier versions of request parameters to support keywords that are supported in later versions of request parameters. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n" + ."\n" + .'> To specify keywords as the content type of the sensitive data detection rule, you can set the Category parameter to 0 for earlier versions of request parameters and set the Category parameter to 5 for later versions of request parameters. You can specify the KeywordCompatible parameter based on your business requirements.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parent group type of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4_1', + ], + ], + [ + 'name' => 'SupportForm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the data asset. Valid values:'."\n" + ."\n" + .'* **0**: all data assets'."\n" + .'* **1**: structured data asset'."\n" + .'* **2**: unstructured data asset'."\n" + ."\n" + .'> If you set the parameter to 1 or 2, rules that support all data assets and rules that support the queried data asset type are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'CooperationChannel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The external cooperation channel. Valid values:'."\n" + ."\n" + .'* DAS'."\n" + .'* YAOCHI'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DAS', + ], + ], + [ + 'name' => 'Simplify', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query a simplified rule. The simplified rule contains only the rule name. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Items' => [ + 'description' => 'The sensitive data detection rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sensitive data detection rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the account that is used to create the sensitive data detection rule.'."\n", + 'type' => 'string', + 'example' => '****test', + ], + 'Status' => [ + 'description' => 'The status of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SupportForm' => [ + 'description' => 'The data asset type that is supported by the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: all data assets'."\n" + .'* **1**: structured data assets'."\n" + .'* **2**: unstructured data assets'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'WarnLevel' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UserId' => [ + 'description' => 'The ID of the account that is used to create the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'StatExpress' => [ + 'description' => 'The statistical expression.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'GmtModified' => [ + 'description' => 'The time when the sensitive data detection rule is modified. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545277010000', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Description' => [ + 'description' => 'The description of the sensitive data detection rule.'."\n", + 'type' => 'string', + 'example' => 'The sensitive data detection rule is used to detect IP addresses.'."\n", + ], + 'ProductId' => [ + 'description' => 'The ID of the service to which the sensitive data detection rule is applied. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Name' => [ + 'description' => 'The name of the sensitive data detection rule.'."\n", + 'type' => 'string', + 'example' => 'IP address'."\n", + ], + 'Content' => [ + 'description' => 'The content in the sensitive data detection rule.'."\n" + ."\n" + .'> A built-in detection rule whose CustomType is 0 does not return the content of the rule.'."\n", + 'type' => 'string', + 'example' => '(?:\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\d|1\\\\d{2}|[1-9]\\\\d{1})\\\\.)(?:(?:25[0-5]|2[0-4]\\\\d|[01]?\\\\d?\\\\d)\\\\.){2}(?:25[0-5]|2[0-4]\\\\d|1[0-9]\\\\d|[1-9]\\\\d|[1-9]))(?:\\\\D|$)', + ], + 'Target' => [ + 'description' => 'The name of the service to which the data asset belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'LoginName' => [ + 'description' => 'The username of the account that is used to create the sensitive data detection rule.'."\n", + 'type' => 'string', + 'example' => 'det1111', + ], + 'CategoryName' => [ + 'description' => 'The name of the content type of the sensitive data detection rule.'."\n", + 'type' => 'string', + 'example' => 'Regular expression'."\n", + ], + 'ContentCategory' => [ + 'description' => 'The type of the content in the sensitive data detection rule. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates attempts to exploit SQL injections. The value 2 indicates bypass by using SQL injections. The value 3 indicates abuse of stored procedures. The value 4 indicates buffer overflow. The value 5 indicates SQL injections based on errors.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HitTotalCount' => [ + 'description' => 'The number of times that the sensitive data detection rule is hit.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'GroupId' => [ + 'description' => 'The parent group type of the rule.'."\n", + 'type' => 'string', + 'example' => '4_1', + ], + 'CustomType' => [ + 'description' => 'The type of the sensitive data detection rule.'."\n" + ."\n" + .'* 0: built-in rule'."\n" + .'* 1: custom rule'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskLevelName' => [ + 'description' => 'The sensitivity level of data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **N/A**: indicates that no sensitive data is detected.'."\n" + .'* **S1**: indicates the low sensitivity level.'."\n" + .'* **S2**: indicates the medium sensitivity level.'."\n" + .'* **S3**: indicates the high sensitivity level.'."\n" + .'* **S4**: indicates the highest sensitivity level.'."\n", + 'type' => 'string', + 'example' => 'S2', + ], + 'GmtCreate' => [ + 'description' => 'The time when the sensitive data detection rule is created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545277010000', + ], + 'Category' => [ + 'description' => 'The content type of the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **0**: keyword'."\n" + .'* **2**: regular expression'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'MajorKey' => [ + 'description' => 'The key of the primary dimension.'."\n", + 'type' => 'string', + 'example' => 'key', + ], + 'Id' => [ + 'description' => 'The ID of the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ProductCode' => [ + 'description' => 'The name of the service to which the data asset belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'MatchType' => [ + 'description' => 'The match type. Valid values:'."\n" + ."\n" + .'* **1**: rule-based match'."\n" + .'* **2**: dictionary-based match'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TemplateRuleIds' => [ + 'description' => 'The IDs of the templates that are used to audit sensitive data.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ModelRuleIds' => [ + 'description' => 'The IDs of the models for sensitive data audit.'."\n", + 'type' => 'string', + 'example' => '1452', + ], + 'ThreatAnalysisStatus' => [ + 'title' => '威胁分析模式状态。0:关闭，1:开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'AuditMode' => [ + 'title' => '审计模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"PageSize\\": 12,\\n \\"TotalCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"DisplayName\\": \\"****test\\",\\n \\"Status\\": 1,\\n \\"SupportForm\\": 2,\\n \\"WarnLevel\\": 2,\\n \\"UserId\\": 0,\\n \\"StatExpress\\": \\"1\\",\\n \\"GmtModified\\": 1545277010000,\\n \\"RiskLevelId\\": 2,\\n \\"Description\\": \\"用于识别IP地址\\",\\n \\"ProductId\\": 2,\\n \\"Name\\": \\"IP地址\\",\\n \\"Content\\": \\"(?:\\\\\\\\\\\\\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\\\\\\\\\\\\\d|1\\\\\\\\\\\\\\\\d{2}|[1-9]\\\\\\\\\\\\\\\\d{1})\\\\\\\\\\\\\\\\.)(?:(?:25[0-5]|2[0-4]\\\\\\\\\\\\\\\\d|[01]?\\\\\\\\\\\\\\\\d?\\\\\\\\\\\\\\\\d)\\\\\\\\\\\\\\\\.){2}(?:25[0-5]|2[0-4]\\\\\\\\\\\\\\\\d|1[0-9]\\\\\\\\\\\\\\\\d|[1-9]\\\\\\\\\\\\\\\\d|[1-9]))(?:\\\\\\\\\\\\\\\\D|$)\\",\\n \\"Target\\": \\"MaxCompute\\",\\n \\"LoginName\\": \\"det1111\\",\\n \\"CategoryName\\": \\"正则表达式\\",\\n \\"ContentCategory\\": \\"1\\",\\n \\"HitTotalCount\\": 3,\\n \\"GroupId\\": \\"4_1\\",\\n \\"CustomType\\": 1,\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"GmtCreate\\": 1545277010000,\\n \\"Category\\": 2,\\n \\"MajorKey\\": \\"key\\",\\n \\"Id\\": 20000,\\n \\"ProductCode\\": \\"MaxCompute\\",\\n \\"MatchType\\": 1,\\n \\"TemplateRuleIds\\": \\"1\\",\\n \\"ModelRuleIds\\": \\"1452\\",\\n \\"ThreatAnalysisStatus\\": 0,\\n \\"AuditMode\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRulesResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n <PageSize>12</PageSize>\\n <TotalCount>23</TotalCount>\\n <Items>\\n <DisplayName>****test</DisplayName>\\n <Status>1</Status>\\n <WarnLevel>2</WarnLevel>\\n <UserId>0</UserId>\\n <StatExpress>1</StatExpress>\\n <GmtModified>1545277010000</GmtModified>\\n <RiskLevelId>2</RiskLevelId>\\n <Description>用于识别IP地址</Description>\\n <ProductId>2</ProductId>\\n <Name>IP地址</Name>\\n <Content>(?:\\\\\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\\\\\d|1\\\\\\\\d{2}|[1-9]\\\\\\\\d{1})\\\\\\\\.)(?:(?:25[0-5]|2[0-4]\\\\\\\\d|[01]?\\\\\\\\d?\\\\\\\\d)\\\\\\\\.){2}(?:25[0-5]|2[0-4]\\\\\\\\d|1[0-9]\\\\\\\\d|[1-9]\\\\\\\\d|[1-9]))(?:\\\\\\\\D|$)</Content>\\n <Target>ODPS</Target>\\n <LoginName>det1111</LoginName>\\n <CategoryName>正则表达式</CategoryName>\\n <ContentCategory>1</ContentCategory>\\n <HitTotalCount>3</HitTotalCount>\\n <GroupId>4_1</GroupId>\\n <CustomType>1</CustomType>\\n <RiskLevelName>S2</RiskLevelName>\\n <GmtCreate>1545277010000</GmtCreate>\\n <Category>2</Category>\\n <MajorKey>key</MajorKey>\\n <Id>20000</Id>\\n <ProductCode>MaxCompute</ProductCode>\\n </Items>\\n</DescribeRulesResponse>","errorExample":""}]', + 'title' => 'DescribeRules', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRiskLevels' => [ + 'summary' => 'Queries the sensitivity levels that are defined in a rule template provided by Data Security Center (DSC).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82064', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* zh_cn: Chinese (default)'."\n" + .'* en_us: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the industry-specific rule template.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '136082B3-B21F-5E9D-B68E-991FFD205D24', + ], + 'RiskLevelList' => [ + 'description' => 'An array that consists of sensitivity levels.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the sensitivity level. The highest sensitivity level varies based on rule templates. The highest sensitivity level is S10. The highest sensitivity level of the **Built-in data security classification templates for Alibaba and Ant Group** is S4, and that of the **built-in classification templates for financial data** and **built-in classification templates for assets** is S5. For more information about the built-in classification templates for financial data, see Guidelines for Security Classification of Financial Data and Security Data - JRT 0197-2020. For a copied rule template, the highest sensitivity level is S10. The following list describes the sensitivity level names and the corresponding IDs:'."\n" + ."\n" + .'* **NA**: 1'."\n" + .'* **S1**: 2'."\n" + .'* **S2**: 3'."\n" + .'* **S3**: 4'."\n" + .'* **S4**: 5'."\n" + .'* **S5**: 6'."\n" + .'* **S6**: 7'."\n" + .'* **S7**: 8'."\n" + .'* **S8**: 9'."\n" + .'* **S9**: 10'."\n" + .'* **S10**: 11'."\n", + 'type' => 'string', + 'example' => 'S1', + ], + 'Description' => [ + 'description' => 'The description of the sensitivity level. You can enter a custom description.'."\n" + ."\n" + .'The following list describes the sensitivity level names and the corresponding default description:'."\n" + ."\n" + .'* **NA**: which indicates that no sensitive data is detected.'."\n" + .'* **S1**: which indicates the sensitive data at sensitivity level 1.'."\n" + .'* **S2**: which indicates the sensitive data at sensitivity level 2.'."\n" + .'* **S3**: which indicates the sensitive data at sensitivity level 3.'."\n" + .'* **S4**: which indicates the sensitive data at sensitivity level 4.'."\n" + .'* **S5**: which indicates the sensitive data at sensitivity level 5.'."\n" + .'* **S6**: which indicates the sensitive data at sensitivity level 6.'."\n" + .'* **S7**: which indicates the sensitive data at sensitivity level 7.'."\n" + .'* **S8**: which indicates the sensitive data at sensitivity level 8.'."\n" + .'* **S9**: which indicates the sensitive data at sensitivity level 9.'."\n" + .'* **S10**: which indicates the sensitive data at sensitivity level 10.'."\n", + 'type' => 'string', + 'example' => 'Sensitive data at sensitivity level 1'."\n", + ], + 'Id' => [ + 'description' => 'The unique ID of the sensitivity level. Valid values: 1 to 11. Each sensitivity level ID maps a sensitivity level. For example, the sensitivity level ID of 2 corresponds to the sensitivity level S1.'."\n" + ."\n" + .'For more information, see the description of the Name parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ReferenceNum' => [ + 'description' => 'The number of times that each sensitivity level is referenced in the rule template. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"136082B3-B21F-5E9D-B68E-991FFD205D24\\",\\n \\"RiskLevelList\\": [\\n {\\n \\"Name\\": \\"S1\\",\\n \\"Description\\": \\"1级敏感数据\\",\\n \\"Id\\": 2,\\n \\"ReferenceNum\\": 20\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRiskLevelsResponse>\\n<RequestId>136082B3-B21F-5E9D-B68E-991FFD205D24</RequestId>\\n<RiskLevelList>\\n <Description>未识别到敏感数据</Description>\\n <Id>1</Id>\\n <ReferenceNum>0</ReferenceNum>\\n <Name>N/A</Name>\\n</RiskLevelList>\\n<RiskLevelList>\\n <Description>1级敏感数据</Description>\\n <Id>2</Id>\\n <ReferenceNum>9</ReferenceNum>\\n <Name>S1</Name>\\n</RiskLevelList>\\n<RiskLevelList>\\n <Description>2级敏感数据</Description>\\n <Id>3</Id>\\n <ReferenceNum>22</ReferenceNum>\\n <Name>S2</Name>\\n</RiskLevelList>\\n<RiskLevelList>\\n <Description>3级敏感数据</Description>\\n <Id>4</Id>\\n <ReferenceNum>18</ReferenceNum>\\n <Name>S3</Name>\\n</RiskLevelList>\\n<RiskLevelList>\\n <Description>4级敏感数据</Description>\\n <Id>5</Id>\\n <ReferenceNum>0</ReferenceNum>\\n <Name>S4</Name>\\n</RiskLevelList>\\n</DescribeRiskLevelsResponse>","errorExample":""}]', + 'title' => 'DescribeRiskLevels', + 'description' => 'You can call this operation to query the sensitivity levels that are defined in the current rule template provided by DSC. This helps you learn about the number of times that each sensitivity level is referenced in the rule template and the highest sensitivity level.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDataAssets' => [ + 'summary' => 'Queries the sensitive data detection results of data assets that Data Security Center (DSC) is authorized to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'example' => 'zh_cn', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword that is used to search for data assets. Fuzzy search is supported.'."\n", + 'example' => 'test', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RiskLevels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the data asset. Separate multiple sensitivity levels with commas (,). Valid values:'."\n" + ."\n" + .'* **2**: S1, indicating the low sensitivity level'."\n" + .'* **3**: S2, indicating the medium sensitivity level'."\n" + .'* **4**: S3, indicating the high sensitivity level'."\n" + .'* **5**: S4, indicating the highest sensitivity level'."\n", + 'example' => '2', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the sensitive data detection rule that the data assets to be queried hit.'."\n" + ."\n" + .'> If you query sensitive data detection results based on the sensitive data detection rule that the data assets hit, you can call the [DescribeRules](~~DescribeRules~~) operation to query the ID of the sensitive data detection rule.'."\n", + 'example' => '11122200', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'RangeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the data asset that you want to query. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute project'."\n" + .'* **2**: MaxCompute table'."\n" + .'* **3**: MaxCompute package'."\n" + .'* **11**: AnalyticDB for MySQL database'."\n" + .'* **12**: AnalyticDB for MySQL table'."\n" + .'* **21**: Object Storage Service (OSS) bucket'."\n" + .'* **22**: OSS object'."\n" + .'* **31**: Tablestore instance'."\n" + .'* **32**: Tablestore table'."\n" + .'* **51**: ApsaraDB RDS database'."\n" + .'* **52**: ApsaraDB RDS table'."\n" + .'* **61**: self-managed database hosted on an Elastic Compute Service (ECS) instance'."\n" + .'* **62**: self-managed table hosted on an ECS instance'."\n" + .'* **71**: PolarDB-X database'."\n" + .'* **72**: PolarDB-X table'."\n" + .'* **81**: PolarDB database'."\n" + .'* **82**: PolarDB table'."\n" + .'* **91**: AnalyticDB for PostgreSQL database'."\n" + .'* **92**: AnalyticDB for PostgreSQL table'."\n", + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **20**.'."\n", + 'example' => '20', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'example' => '71064826-726F-4ADA-B879-05D8055476FB', + 'type' => 'string', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'example' => '20', + 'format' => 'int32', + 'type' => 'integer', + ], + 'TotalCount' => [ + 'description' => 'The total number of queried data assets that contain sensitive data.'."\n", + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Items' => [ + 'description' => 'An array that consists of data assets.'."\n", + 'items' => [ + 'properties' => [ + 'Acl' => [ + 'description' => 'The access control list (ACL) that controls the access permissions on the OSS bucket.'."\n" + ."\n" + .'> This parameter is returned only when you set the parameter **RangeId** to **21**.'."\n", + 'example' => 'private', + 'type' => 'string', + ], + 'CreationTime' => [ + 'description' => 'The time when the data asset was created. Unit: milliseconds.'."\n", + 'example' => '1536751124000', + 'format' => 'int64', + 'type' => 'integer', + ], + 'DataType' => [ + 'description' => 'The data type of the data asset.'."\n", + 'example' => 'OSS_BUCKET', + 'type' => 'string', + ], + 'Owner' => [ + 'description' => 'The account that owns the data asset.'."\n", + 'example' => 'dtdep-239-******', + 'type' => 'string', + ], + 'SensitiveRatio' => [ + 'description' => 'The percentage of sensitive data in all data assets.'."\n", + 'example' => '45%', + 'type' => 'string', + ], + 'Protection' => [ + 'description' => 'Indicates whether the data protection mechanism is enabled for the data asset. The value is fixed as **false**. **true** or **false** is returned for this parameter only when you set the parameter **RangeId** to **1**.'."\n" + ."\n" + .'* **false**: The data protection mechanism is disabled.'."\n" + .'* **true**: The data protection mechanism is enabled. Only data inbound is supported. Data outbound is not supported.'."\n", + 'example' => 'false', + 'type' => 'boolean', + ], + 'Labelsec' => [ + 'description' => 'The sensitivity tag of the data. The value is fixed as **0**. **0**, **1**, **2**, or **3** is returned for this parameter only when you set the parameter **RangeId** to **1**.'."\n" + ."\n" + .'* **0**: unclassified'."\n" + .'* **1**: confidential'."\n" + .'* **2**: sensitive'."\n" + .'* **3**: highly sensitive'."\n", + 'example' => '0', + 'type' => 'boolean', + ], + 'TotalCount' => [ + 'description' => 'The total number of data assets. For example, the value can be the total number of MaxCompute projects, packages, or tables, the total number of ApsaraDB RDS databases or tables, or the total number of OSS buckets or objects.'."\n", + 'example' => '432', + 'format' => 'int32', + 'type' => 'integer', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the data asset. A higher sensitivity level indicates that the identified data is more sensitive. Valid values:'."\n" + ."\n" + .'* **1**: No sensitive data is identified.'."\n" + .'* **2**: sensitive data at level 1.'."\n" + .'* **3**: sensitive data at level 2.'."\n" + .'* **3**: sensitive data at level 3.'."\n" + .'* **5**: sensitive data at level 4.'."\n" + .'* **6**: sensitive data at level 5.'."\n" + .'* **7**: sensitive data at level 6.'."\n" + .'* **8**: sensitive data at level 7.'."\n" + .'* **9**: sensitive data at level 8.'."\n" + .'* **10**: sensitive data at level 9.'."\n" + .'* **11**: sensitive data at level 10.'."\n", + 'example' => '2', + 'format' => 'int64', + 'type' => 'integer', + ], + 'RuleName' => [ + 'description' => 'The name of the sensitive data detection rule that the data asset hits.'."\n", + 'example' => '\\*\\*\\* rule'."\n", + 'type' => 'string', + ], + 'Sensitive' => [ + 'description' => 'Indicates whether the data asset contains sensitive data. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'example' => 'true', + 'type' => 'boolean', + ], + 'ObjectKey' => [ + 'description' => 'The key value of the OSS object.'."\n" + ."\n" + .'> This parameter is returned only when you set the parameter **RangeId** to **22**.'."\n", + 'example' => 'Internal'."\n", + 'type' => 'string', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the data asset.'."\n", + 'example' => 'Medium sensitivity level'."\n", + 'type' => 'string', + ], + 'OdpsRiskLevelName' => [ + 'description' => 'The sensitivity level of the MaxCompute data asset. Valid values:'."\n" + ."\n" + .'* **S1**: low sensitivity level'."\n" + .'* **S2**: medium sensitivity level'."\n" + .'* **S3**: high sensitivity level'."\n" + .'* **S4**: highest sensitivity level'."\n" + ."\n" + .'> This parameter is returned only when you set the parameter **RangeId** to **1**.'."\n", + 'example' => 'S4', + 'type' => 'string', + ], + 'ProductId' => [ + 'description' => 'The ID of the service to which the data asset belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: OSS'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore'."\n" + .'* **5**: ApsaraDB RDS'."\n", + 'example' => '5', + 'type' => 'string', + ], + 'Name' => [ + 'description' => 'The name of the data asset.'."\n", + 'example' => 'gxdata', + 'type' => 'string', + ], + 'SensitiveCount' => [ + 'description' => 'The total number of sensitive data assets. For example, the value can be the total number of sensitive MaxCompute projects, packages, or tables, the total number of sensitive ApsaraDB RDS databases or tables, or the total number of sensitive OSS buckets or objects.'."\n", + 'example' => '24', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Id' => [ + 'description' => 'The ID of the data asset.'."\n", + 'example' => '268', + 'type' => 'string', + ], + 'ProductCode' => [ + 'description' => 'The name of the service to which the data asset belongs.'."\n", + 'example' => 'RDS', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"71064826-726F-4ADA-B879-05D8055476FB\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Acl\\": \\"private\\",\\n \\"CreationTime\\": 1536751124000,\\n \\"DataType\\": \\"OSS_BUCKET\\",\\n \\"Owner\\": \\"dtdep-239-******\\",\\n \\"SensitiveRatio\\": \\"45%\\",\\n \\"Protection\\": false,\\n \\"Labelsec\\": true,\\n \\"TotalCount\\": 432,\\n \\"RiskLevelId\\": 2,\\n \\"RuleName\\": \\"***规则\\",\\n \\"Sensitive\\": true,\\n \\"ObjectKey\\": \\"内部\\",\\n \\"RiskLevelName\\": \\"中等风险等级\\",\\n \\"OdpsRiskLevelName\\": \\"S4\\",\\n \\"ProductId\\": \\"5\\",\\n \\"Name\\": \\"gxdata\\",\\n \\"SensitiveCount\\": 24,\\n \\"Id\\": \\"268\\",\\n \\"ProductCode\\": \\"RDS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataAssetsResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>71064826-726F-4ADA-B879-05D8055476FB</RequestId>\\n <PageSize>20</PageSize>\\n <TotalCount>1</TotalCount>\\n <Items>\\n <Acl>private</Acl>\\n <CreationTime>1536751124000</CreationTime>\\n <DataType>OSS_BUCKET</DataType>\\n <Owner>dtdep-239-******</Owner>\\n <SensitiveRatio>45%</SensitiveRatio>\\n <Protection>false</Protection>\\n <Labelsec>false</Labelsec>\\n <TotalCount>432</TotalCount>\\n <RiskLevelId>2</RiskLevelId>\\n <RuleName>***规则</RuleName>\\n <Sensitive>true</Sensitive>\\n <ObjectKey>内部</ObjectKey>\\n <RiskLevelName>中等风险等级</RiskLevelName>\\n <OdpsRiskLevelName>S4</OdpsRiskLevelName>\\n <ProductId>5</ProductId>\\n <Name>gxdata</Name>\\n <SensitiveCount>24</SensitiveCount>\\n <Id>268</Id>\\n <ProductCode>RDS</ProductCode>\\n </Items>\\n</DescribeDataAssetsResponse>","errorExample":""}]', + 'extraInfo' => ' ', + 'title' => 'DescribeDataAssets', + ], + 'DescribeInstances' => [ + 'summary' => 'Queries data assets such as MaxCompute, ApsaraDB RDS, and Object Storage Service (OSS) that you authorize Data Security Center (DSC) to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82047', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword that is used to search for data assets. DSC searches for data assets based on the keyword that you specify in fuzzy match mode. For example, if you specify data, all data assets whose names contain data are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'data', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the data asset belongs. You can call the [DescribeDataAssets](~~DescribeDataAssets~~) operation to query the ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level ID of the data asset. A higher sensitivity level indicates that the identified data is more sensitive. Valid values:'."\n" + ."\n" + .'* **1**: No sensitive data is identified.'."\n" + .'* **2**: sensitive data at level 1.'."\n" + .'* **3**: sensitive data at level 2.'."\n" + .'* **4**: sensitive data at level 3'."\n" + .'* **5**: sensitive data at level 4.'."\n" + .'* **6**: sensitive data at level 5.'."\n" + .'* **7**: sensitive data at level 6.'."\n" + .'* **8**: sensitive data at level 7.'."\n" + .'* **9**: sensitive data at level 8.'."\n" + .'* **10**: sensitive data at level 9.'."\n" + .'* **11**: sensitive data at level 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule that the data asset hits. You can call the [DescribeRules](~~DescribeRules~~) operation and obtain the ID of the sensitive data detection rule from the **Id** response parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1111111', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the data asset resides. For more information, see [Supported regions](~~214257~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which the data asset belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets from which DSC can scan for sensitive data, see [Supported data assets](~~212906~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '71064826-726F-4ADA-B879-05D8055476FB', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of data assets.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '231', + ], + 'Items' => [ + 'description' => 'The data assets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the data asset was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637226782000', + ], + 'LastFinishTime' => [ + 'description' => 'The time when the data asset was last scanned. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637622793000', + ], + 'Owner' => [ + 'description' => 'The Alibaba Cloud account to which the data asset belongs.'."\n", + 'type' => 'string', + 'example' => 'dtdep-239-******', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant.'."\n", + 'type' => 'string', + 'example' => 'Tenant 1'."\n", + ], + 'Protection' => [ + 'description' => 'The protection status of the data asset. Valid values:'."\n" + ."\n" + .'* **true**: The data asset is being protected.'."\n" + .'* **false**: The data asset is not protected.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'DepartName' => [ + 'description' => 'The name of the department to which the data asset belongs.'."\n", + 'type' => 'string', + 'example' => '***DemoCenter', + ], + 'Labelsec' => [ + 'description' => 'The security status of the data asset. Valid values:'."\n" + ."\n" + .'* **true**: The data asset is secure.'."\n" + .'* **false**: The data asset is insecure.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RiskLevelId' => [ + 'description' => 'The ID of the sensitivity level for the data asset. A higher sensitivity level ID indicates that the identified data is more sensitive.'."\n" + ."\n" + .'* **1**: No sensitive data is detected.'."\n" + .'* **2**: sensitive data at level 1.'."\n" + .'* **3**: sensitive data at level 2.'."\n" + .'* **4**: sensitive data at level 3.'."\n" + .'* **5**: sensitive data at level 4.'."\n" + .'* **6**: sensitive data at level 5.'."\n" + .'* **7**: sensitive data at level 6.'."\n" + .'* **8**: sensitive data at level 7.'."\n" + .'* **9**: sensitive data at level 8.'."\n" + .'* **10**: sensitive data at level 9.'."\n" + .'* **11**: sensitive data at level 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ProductId' => [ + 'description' => 'The ID of the service to which the data asset belongs.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'Name' => [ + 'description' => 'The name of the data asset.'."\n", + 'type' => 'string', + 'example' => 'gxdata', + ], + 'TotalCount' => [ + 'description' => 'The total number of data objects in the data asset. For example, if the data asset is an ApsaraDB RDS instance, the value indicates the total number of tables in all databases of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '231', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the data asset.'."\n", + 'type' => 'string', + 'example' => 'Data asset Information 1'."\n", + ], + 'RuleName' => [ + 'description' => 'The name of the sensitive data detection rule that the data asset hits.'."\n", + 'type' => 'string', + 'example' => '\\*\\*\\* rule'."\n", + ], + 'Sensitive' => [ + 'description' => 'Indicates whether the data asset contains sensitive data. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the data asset.'."\n", + 'type' => 'string', + 'example' => 'Sensitive data at level 1'."\n", + ], + 'OdpsRiskLevelName' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SensitiveCount' => [ + 'description' => 'The number of sensitive data objects in the data asset. For example, if the data asset is an ApsaraDB RDS instance, the value indicates the number of sensitive tables in all databases of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'Id' => [ + 'description' => 'The unique ID of the data asset in DSC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111', + ], + 'ProductCode' => [ + 'description' => 'The name of the service to which the data asset belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets that DSC can scan to detect sensitive data, see [Supported data assets](~~212906~~).'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'ModelTags' => [ + 'description' => 'A list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the tag. Valid values:'."\n" + ."\n" + .'* **101**: personal sensitive information'."\n" + .'* **102**: personal information'."\n" + .'* **107**: general information'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'The name of the tag. Valid values:'."\n" + ."\n" + .'* Personal sensitive information'."\n" + .'* Personal information'."\n" + .'* General information'."\n", + 'type' => 'string', + 'example' => 'personal sensitive data', + ], + ], + ], + ], + 'MemberAliUid' => [ + 'description' => 'If the management account has opened multiple accounts and the asset belongs to other member accounts, this field displays the UID of the member accounts.', + 'type' => 'string', + 'example' => '12567890126', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"71064826-726F-4ADA-B879-05D8055476FB\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 231,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1637226782000,\\n \\"LastFinishTime\\": 1637622793000,\\n \\"Owner\\": \\"dtdep-239-******\\",\\n \\"TenantName\\": \\"tenant\\",\\n \\"Protection\\": false,\\n \\"DepartName\\": \\"***DemoCenter\\",\\n \\"Labelsec\\": true,\\n \\"RiskLevelId\\": 2,\\n \\"ProductId\\": \\"5\\",\\n \\"Name\\": \\"gxdata\\",\\n \\"TotalCount\\": 231,\\n \\"InstanceDescription\\": \\"instance dscription\\",\\n \\"RuleName\\": \\"*** rule\\",\\n \\"Sensitive\\": true,\\n \\"RiskLevelName\\": \\"S1\\",\\n \\"OdpsRiskLevelName\\": \\"1\\",\\n \\"SensitiveCount\\": 123,\\n \\"Id\\": 11111,\\n \\"ProductCode\\": \\"RDS\\",\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"personal sensitive data\\"\\n }\\n ],\\n \\"MemberAliUid\\": \\"12567890126\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstancesResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>71064826-726F-4ADA-B879-05D8055476FB</RequestId>\\n <PageSize>10</PageSize>\\n <TotalCount>231</TotalCount>\\n <Items>\\n <CreationTime>1637226782000</CreationTime>\\n <LastFinishTime>1637622793000</LastFinishTime>\\n <Owner>dtdep-239-******</Owner>\\n <TenantName>租户1</TenantName>\\n <Protection>false</Protection>\\n <DepartName>***DemoCenter</DepartName>\\n <Labelsec>true</Labelsec>\\n <RiskLevelId>2</RiskLevelId>\\n <ProductId>5</ProductId>\\n <Name>gxdata</Name>\\n <TotalCount>231</TotalCount>\\n <InstanceDescription>实例信息1</InstanceDescription>\\n <RuleName>***规则</RuleName>\\n <Sensitive>true</Sensitive>\\n <RiskLevelName>1级敏感数据风险</RiskLevelName>\\n <OdpsRiskLevelName>1</OdpsRiskLevelName>\\n <SensitiveCount>123</SensitiveCount>\\n <Id>11111</Id>\\n <ProductCode>RDS</ProductCode>\\n </Items>\\n</DescribeInstancesResponse>","errorExample":""}]', + 'title' => 'DescribeInstances', + 'description' => 'When you call the DescribeInstances operation, you can specify parameters such as Name and RiskLevelId to query data assets that meet filter conditions.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeTables' => [ + 'summary' => 'Queries tables in data assets such as MaxCompute projects and ApsaraDB RDS instances that Data Security Center (DSC) is authorized to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'example' => 'zh_cn', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The search keyword. Fuzzy match is supported. For example, if you specify test, all tables whose names contain test are retrieved.'."\n", + 'example' => 'test', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the table belongs. You can call the [DescribeDataAssets](~~DescribeDataAssets~~) operation to obtain the ID of the service.'."\n", + 'example' => '1', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which the table belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets from which Data Security Center (DSC) can scan for sensitive data, see [Supported data assets](~~212906~~).'."\n", + 'example' => 'MaxCompute', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the table. Each sensitivity level ID corresponds to a sensitivity level name. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'example' => '2', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule that the table hits. You can call the [DescribeRules](~~DescribeRules~~) operation to obtain the ID of the sensitive data detection rule.'."\n", + 'example' => '333322', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data asset to which the table belongs. You can call the [DescribeInstances](~~DescribeInstances~~) operation to obtain the ID of the data asset.'."\n", + 'example' => '1', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'PackageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the package to which the table belongs. You can call the [DescribePackages](~~DescribePackages~~) operation to obtain the ID of the package.'."\n", + 'example' => '555555', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", + 'example' => '10', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Default value: 1.'."\n", + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which DSC is activated. For more information, see [Supported regions](~~214257~~).'."\n", + 'example' => 'cn-hangzhou', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the industry-specific rule template.'."\n", + 'example' => '1', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + 'type' => 'string', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'example' => '13', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Items' => [ + 'description' => 'An array that consists of tables.'."\n", + 'items' => [ + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The point in time when the table was created. Unit: milliseconds.'."\n", + 'example' => '1536751124000', + 'format' => 'int64', + 'type' => 'integer', + ], + 'Owner' => [ + 'description' => 'The Alibaba Cloud account to which the table belongs.'."\n", + 'example' => 'dtdep-239-******', + 'type' => 'string', + ], + 'SensitiveRatio' => [ + 'description' => 'The percentage of sensitive fields in the table.'."\n", + 'example' => '21%', + 'type' => 'string', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant.'."\n", + 'example' => 'Tenant 1'."\n", + 'type' => 'string', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the table. Each sensitivity level ID corresponds to a sensitivity level name. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'example' => '2', + 'format' => 'int64', + 'type' => 'integer', + ], + 'InstanceName' => [ + 'description' => 'The name of the data asset to which the table belongs.'."\n", + 'example' => 'Data Asset 1'."\n", + 'type' => 'string', + ], + 'ProductId' => [ + 'description' => 'The ID of the service to which the table belongs.'."\n", + 'example' => '1', + 'type' => 'string', + ], + 'Name' => [ + 'description' => 'The name of the table.'."\n", + 'example' => 'gxdata', + 'type' => 'string', + ], + 'InstanceId' => [ + 'description' => 'The ID of the data asset to which the table belongs.'."\n", + 'example' => '1', + 'format' => 'int64', + 'type' => 'integer', + ], + 'TotalCount' => [ + 'description' => 'The total number of fields in the table.'."\n", + 'example' => '1234', + 'format' => 'int32', + 'type' => 'integer', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the data asset.'."\n", + 'example' => 'Description 1'."\n", + 'type' => 'string', + ], + 'Sensitive' => [ + 'description' => 'Indicates whether the table contains sensitive fields. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'example' => 'true', + 'type' => 'boolean', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the table. Valid values:'."\n" + ."\n" + .'* **N/A**: indicates that no sensitive data is detected.'."\n" + .'* **S1**: indicates the low sensitivity level.'."\n" + .'* **S2**: indicates the medium sensitivity level.'."\n" + .'* **S3**: indicates the high sensitivity level.'."\n" + .'* **S4**: indicates the highest sensitivity level.'."\n", + 'example' => 'S2', + 'type' => 'string', + ], + 'SensitiveCount' => [ + 'description' => 'The total number of sensitive fields in the table.'."\n", + 'example' => '32', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Id' => [ + 'description' => 'The ID of the table.'."\n", + 'example' => '222', + 'format' => 'int64', + 'type' => 'integer', + ], + 'ProductCode' => [ + 'description' => 'The name of the service to which the table belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**. For more information about the types of data assets from which DSC can scan for sensitive data, see [Supported data assets](~~212906~~).'."\n", + 'example' => 'MaxCompute', + 'type' => 'string', + ], + 'RuleList' => [ + 'description' => 'The information about the sensitive data detection rules that are hit.'."\n", + 'items' => [ + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the rule.'."\n", + 'example' => 'Rule name'."\n", + 'type' => 'string', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'example' => '1', + 'format' => 'int64', + 'type' => 'integer', + ], + 'Count' => [ + 'description' => 'The total number of rules.'."\n", + 'example' => '12', + 'format' => 'int64', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1536751124000,\\n \\"Owner\\": \\"dtdep-239-******\\",\\n \\"SensitiveRatio\\": \\"21%\\",\\n \\"TenantName\\": \\"租户1\\",\\n \\"RiskLevelId\\": 2,\\n \\"InstanceName\\": \\"实例1\\",\\n \\"ProductId\\": \\"1\\",\\n \\"Name\\": \\"gxdata\\",\\n \\"InstanceId\\": 1,\\n \\"TotalCount\\": 1234,\\n \\"InstanceDescription\\": \\"备注1\\",\\n \\"Sensitive\\": true,\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"SensitiveCount\\": 32,\\n \\"Id\\": 222,\\n \\"ProductCode\\": \\"MaxCompute\\",\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"规则名称\\",\\n \\"RiskLevelId\\": 1,\\n \\"Count\\": 12\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>13</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n<CurrentPage>1</CurrentPage>\\n<Items>\\n <Owner>dtdep-239-******</Owner>\\n <ProductCode>MaxCompute</ProductCode>\\n <InstanceId>1</InstanceId>\\n <TenantName>租户1</TenantName>\\n <SensitiveRatio>21%</SensitiveRatio>\\n <ProductId>1</ProductId>\\n <RiskLevelId>2</RiskLevelId>\\n <Name>gxdata</Name>\\n <InstanceName>实例1</InstanceName>\\n <TotalCount>1234</TotalCount>\\n <CreationTime>1536751124000</CreationTime>\\n <Sensitive>true</Sensitive>\\n <RiskLevelName>最高风险等级</RiskLevelName>\\n <InstanceDescription>备注1</InstanceDescription>\\n <Id>222</Id>\\n <SensitiveCount>32</SensitiveCount>\\n <RuleList>\\n <Count>12</Count>\\n <RiskLevelId>1</RiskLevelId>\\n <Name>规则名称</Name>\\n </RuleList>\\n</Items>","errorExample":""}]', + 'description' => 'When you call the DescribeTables operation to query tables, you can specify parameters such as Name and RiskLevelId to filter tables.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can send up to 10 requests per second to call this operation by using your Alibaba Cloud account. If you send excessive requests, throttling is implemented, and your business may be affected.'."\n", + 'extraInfo' => ' ', + 'title' => 'DescribeTables', + ], + 'DescribeColumns' => [ + 'summary' => 'Queries data in the columns of the tables that Data Security Center (DSC) is authorized to access. The tables include the tables of MaxCompute and ApsaraDB RDS.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82001', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The search keyword. Fuzzy match is supported.'."\n" + ."\n" + .'For example, if you enter **test**, all columns whose names contain **test** are retrieved.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'TableId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the table to which the column belongs.'."\n" + ."\n" + .'> You can call the [DescribeTables](~~DescribeTables~~) operation to query the IDs of tables.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11132334', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule that data in the column of the table hits.'."\n" + ."\n" + .'> You can call the [DescribeRules](~~DescribeRules~~) operation to query the IDs of sensitive data detection rules.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11111', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which data in the column of the table belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which data in the column of the table belongs.'."\n" + ."\n" + .'> You can call the [DescribeInstances](~~DescribeRules~~) operation to query the IDs of instances.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance to which data in the column of the table belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp17t1htja573l5i8****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'it_table', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the sensitive data detection rule that data in the column of the table hits.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ID card number (the Chinese mainland)'."\n", + ], + ], + [ + 'name' => 'SensLevelName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the sensitivity level of the data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **N/A**: No sensitive data is detected.'."\n" + .'* **S1**: indicates the low sensitivity level.'."\n" + .'* **S2**: indicates the medium sensitivity level.'."\n" + .'* **S3**: indicates the high sensitivity level.'."\n" + .'* **S4**: indicates the highest sensitivity level.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'S2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:'."\n" + ."\n" + .'* **1**: N/A'."\n" + .'* **2**: S1'."\n" + .'* **3**: S2'."\n" + .'* **4**: S3'."\n" + .'* **5**: S4'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'TemplateRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the template rule that is hit.'."\n" + ."\n" + .'> You can call the [DescribeCategoryTemplateRuleList](~~410143~~) operation to obtain the IDs of hit template rules.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1542', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine type. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **MariaDB**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + .'* **SQLServer**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the data object belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: Object Storage Service (OSS)'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore (OTS)'."\n" + .'* **5**: ApsaraDB RDS'."\n" + .'* **6**: self-managed database'."\n" + .'* **7**: PolarDB for Xscale (PolarDB-X)'."\n" + .'* **8**: PolarDB'."\n" + .'* **9**: AnalyticDB for PostgreSQL'."\n" + .'* **10**: ApsaraDB for OceanBase'."\n" + .'* **11**: ApsaraDB for MongoDB'."\n" + .'* **25**: ApsaraDB for Redis'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ModelTagId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data tag.'."\n" + ."\n" + .'* 101: personal sensitive information'."\n" + .'* 102: personal information'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '101', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the industry-specific classification template.'."\n" + ."\n" + .'> You can call the [DescribeCategoryTemplateList](~~2399296~~) operation to obtain the IDs of industry-specific classification templates.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-4******', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'description' => 'The data in the columns of the table.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the data in the column of the table is created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1536751124000', + ], + 'TableName' => [ + 'description' => 'The name of the table to which the revised column belongs.'."\n", + 'type' => 'string', + 'example' => 'it_table', + ], + 'DataType' => [ + 'description' => 'The type of data in the column of the table.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'OdpsRiskLevelValue' => [ + 'description' => 'The ID of the sensitivity level of the asset. Valid values:'."\n" + ."\n" + .'* **1**: N/A'."\n" + .'* **2**: S1'."\n" + .'* **3**: S2'."\n" + .'* **4**: S3'."\n" + .'* **5**: S4'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance to which data in the column of the table belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskLevelId' => [ + 'description' => 'The ID of the sensitivity level of data in the column of the table. Valid values:'."\n" + ."\n" + .'* **1**: N/A'."\n" + .'* **2**: S1'."\n" + .'* **3**: S2'."\n" + .'* **4**: S3'."\n" + .'* **5**: S4'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RuleName' => [ + 'description' => 'The name of the sensitive data detection rule that data in the column of the table hits.'."\n", + 'type' => 'string', + 'example' => '\\*\\* rule'."\n", + ], + 'RuleId' => [ + 'description' => 'The ID of the sensitive data detection rule that data in the column of the table hits.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Sensitive' => [ + 'description' => 'Indicates whether the column contains sensitive data. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SensLevelName' => [ + 'description' => 'The name of the sensitivity level. Valid values:'."\n" + ."\n" + .'* **N/A**: indicates that no sensitive data is detected.'."\n" + .'* **S1**: indicates the low sensitivity level.'."\n" + .'* **S2**: indicates the medium sensitivity level.'."\n" + .'* **S3**: indicates the high sensitivity level.'."\n" + .'* **S4**: indicates the highest sensitivity level.'."\n", + 'type' => 'string', + 'example' => 'S2', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance to which data in the column of the table belongs.'."\n", + 'type' => 'string', + 'example' => 'rm-bp17t1htja573l5i8****', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for data in the column of the table. Valid values:'."\n" + ."\n" + .'* **N/A**: indicates that no sensitive data is detected.'."\n" + .'* **S1**: indicates the low sensitivity level.'."\n" + .'* **S2**: indicates the medium sensitivity level.'."\n" + .'* **S3**: indicates the high sensitivity level.'."\n" + .'* **S4**: indicates the highest sensitivity level.'."\n", + 'type' => 'string', + 'example' => 'S2', + ], + 'OdpsRiskLevelName' => [ + 'description' => 'The name of the sensitivity level for asset. Valid values:'."\n" + ."\n" + .'* **N/A**: indicates that no sensitive data is detected.'."\n" + .'* **S1**: indicates the low sensitivity level.'."\n" + .'* **S2**: indicates the medium sensitivity level.'."\n" + .'* **S3**: indicates the high sensitivity level.'."\n" + .'* **S4**: indicates the highest sensitivity level.'."\n", + 'type' => 'string', + 'example' => 'S3', + ], + 'Name' => [ + 'description' => 'The name of the column of the table.'."\n", + 'type' => 'string', + 'example' => 'gxdata', + ], + 'TableId' => [ + 'description' => 'The ID of the table.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Id' => [ + 'description' => 'The ID of the column of the table.'."\n", + 'type' => 'string', + 'example' => '268', + ], + 'ProductCode' => [ + 'description' => 'The name of the service to which data in the column of the table belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'RevisionStatus' => [ + 'description' => 'Indicates whether the column is revised. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RevisionId' => [ + 'description' => 'The ID of the revision record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'ModelTags' => [ + 'description' => 'A list of tags for data that hits the recognition model.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The tag ID.'."\n" + ."\n" + .'* **101**: sensitive personal information'."\n" + .'* **102**: personal information'."\n" + .'* **103**: important information'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'The tag name.'."\n" + ."\n" + .'* Sensitive personal information'."\n" + .'* Personal information'."\n" + .'* Important information'."\n", + 'type' => 'string', + 'example' => 'personal sensitive data', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => 'The region in which the asset resides.'."\n", + 'type' => 'string', + 'example' => 'cn-***', + ], + 'EngineType' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MaskingStatus' => [ + 'description' => 'The column encryption status. Valid values:'."\n" + ."\n" + .'* **-1**: unencrypted'."\n" + .'* **1**: encrypted'."\n" + .'* **2**: encryption failed'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'ProductId' => [ + 'description' => 'The ID of the service to which the data object belongs. Valid values:'."\n" + ."\n" + .'* **1**: MaxCompute'."\n" + .'* **2**: Object Storage Service (OSS)'."\n" + .'* **3**: AnalyticDB for MySQL'."\n" + .'* **4**: Tablestore (OTS)'."\n" + .'* **5**: ApsaraDB RDS'."\n" + .'* **6**: self-managed database'."\n" + .'* **7**: PolarDB for Xscale (PolarDB-X)'."\n" + .'* **8**: PolarDB'."\n" + .'* **9**: AnalyticDB for PostgreSQL'."\n" + .'* **10**: ApsaraDB for OceanBase'."\n" + .'* **11**: ApsaraDB for MongoDB'."\n" + .'* **25**: ApsaraDB for Redis'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-4******\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1536751124000,\\n \\"TableName\\": \\"it_table\\",\\n \\"DataType\\": \\"String\\",\\n \\"OdpsRiskLevelValue\\": 3,\\n \\"InstanceId\\": 1,\\n \\"RiskLevelId\\": 2,\\n \\"RuleName\\": \\"name\\",\\n \\"RuleId\\": 1,\\n \\"Sensitive\\": false,\\n \\"SensLevelName\\": \\"S2\\",\\n \\"InstanceName\\": \\"rm-bp17t1htja573l5i8****\\",\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"OdpsRiskLevelName\\": \\"S3\\",\\n \\"Name\\": \\"gxdata\\",\\n \\"TableId\\": 123,\\n \\"Id\\": \\"268\\",\\n \\"ProductCode\\": \\"MaxCompute\\",\\n \\"RevisionStatus\\": 1,\\n \\"RevisionId\\": 12,\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"personal sensitive data\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-***\\",\\n \\"EngineType\\": \\"MySQL\\",\\n \\"MaskingStatus\\": -1,\\n \\"ProductId\\": 5\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeColumnsResponse>\\r\\n\\t<RequestId>769FB3C1-F4C9-4******</RequestId>\\r\\n\\t<TotalCount>4</TotalCount>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<CurrentPage>1</CurrentPage>\\r\\n\\t<Items>\\r\\n\\t\\t<Owner>dtdep-239-***</Owner>\\r\\n\\t\\t<ProductCode>RDS</ProductCode>\\r\\n\\t\\t<RiskLevelId>2</RiskLevelId>\\r\\n\\t\\t<RiskLevelName>S2</RiskLevelName>\\r\\n\\t\\t<DepartName>***DemoCenter</DepartName>\\r\\n\\t\\t<Name>gxdata</Name>\\r\\n\\t\\t<CreationTime>1536751124000</CreationTime>\\r\\n\\t\\t<Sensitive>true</Sensitive>\\r\\n\\t\\t<Id>268</Id>\\r\\n\\t\\t<RuleId>1</RuleId>\\r\\n\\t\\t<RuleName>**规则</RuleName>\\r\\n\\t\\t<InstanceId>1</InstanceId>\\r\\n\\t\\t<TableId>123</TableId>\\r\\n\\t</Items>\\r\\n</DescribeColumnsResponse>\\t\\r\\n","errorExample":""}]', + 'title' => 'DescribeColumns', + 'description' => 'You can call this operation to query the data in columns of a table that may contain sensitive data. This helps you analyze sensitive data.'."\n" + ."\n" + .'## [](#)Precautions'."\n" + ."\n" + .'The DescribeColumns operation is changed to DescribeColumnsV2. We recommend that you call the DescribeColumnsV2 operation when you develop your applications.'."\n" + ."\n" + .'## [](#qps)Limits'."\n" + ."\n" + .'Each Alibaba Cloud account can call this operation up to 10 times per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeColumnsV2' => [ + 'summary' => 'Query data in columns of data assets such as MaxCompute, RDS, etc., that are authorized by the Data Security Center.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the language type for requests and received messages, default is **zh_cn**.'."\n" + .'Values:'."\n" + ."\n" + .'- **zh_cn**: Simplified Chinese'."\n" + .'- **en_us**: English (United States)', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search keyword, supports fuzzy matching.'."\n" + ."\n" + .'For example, entering **test** will search for all data information containing **test** in the search items.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'TableId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier ID of the asset table to which the column in MaxCompute, RDS, etc., belongs.'."\n" + ."\n" + .'> Query the data in the columns of the data assets authorized by the Data Security Center based on the ID of the asset table. The asset table ID can be obtained by calling the [DescribeTables](~~141709~~) interface.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11132334', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier ID of the sensitive data recognition rule hit by the column data in the asset table.'."\n" + ."\n" + .'> Query the data in the columns of the data assets authorized by the Data Security Center based on the ID of the sensitive data recognition rule hit by the column data in the asset table. The sensitive data recognition rule ID can be obtained by calling the [DescribeRules](~~141389~~) interface.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11122200', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product name to which the column data in the data asset table belongs. Values: **MaxCompute, OSS, ADS, OTS, RDS**, etc.', + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the asset instance to which the column data in the data asset table belongs.'."\n" + ."\n" + .'> Query the data in the columns of the data assets authorized by the Data Security Center based on the ID of the asset instance to which the column data in the data asset table belongs. The asset instance ID can be obtained by calling the [DescribeInstances](~~141708~~) interface.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the asset instance to which the column data in the data asset table belongs.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp17t1htja573l5i8****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the data asset table.', + 'type' => 'string', + 'required' => false, + 'example' => 'it_table', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the sensitive data recognition rule hit by the column data in the data asset table.', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'SensLevelName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sensitive level name. Values:'."\n" + .'- **N/A**: No sensitive data detected.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'required' => false, + 'example' => 'S2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, sets the maximum number of data asset instances displayed per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, sets the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Risk level ID of the sensitive data recognition rule. Values:'."\n" + .'- **1**: N/A.'."\n" + .'- **2**: S1.'."\n" + .'- **3**: S2.'."\n" + .'- **4**: S3.'."\n" + .'- **5**: S4.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Engine type. Values:'."\n" + .'- **MySQL**.'."\n" + .'- **MariaDB**.'."\n" + .'- **Oracle**.'."\n" + .'- **PostgreSQL**.'."\n" + .'- **SQLServer**.', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'When performing a paginated query, sets the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', + 'type' => 'string', + 'example' => 'B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0', + ], + 'PageSize' => [ + 'description' => 'When performing a paginated query, sets the maximum number of data asset instances displayed per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'Total number of data entries in the result.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'description' => 'List of recognition results for the columns in the data table.', + 'type' => 'array', + 'items' => [ + 'description' => 'Recognition result object for the columns in the data table.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The creation time of the column data in the data asset table, in milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1536751124000', + ], + 'TableName' => [ + 'description' => 'The name of the table to which the target column for correction belongs.', + 'type' => 'string', + 'example' => 'it_table', + ], + 'DataType' => [ + 'description' => 'The data type of the column data in the data asset table.', + 'type' => 'string', + 'example' => 'varchar', + ], + 'OdpsRiskLevelValue' => [ + 'description' => 'The risk level code of the asset. Values:'."\n" + ."\n" + .'- **1**: N/A.'."\n" + .'- **2**: S1.'."\n" + .'- **3**: S2.'."\n" + .'- **4**: S3.'."\n" + .'- **5**: S4.'."\n" + ."\n" + .'> A return value <= 1 represents N/A.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'InstanceId' => [ + 'description' => 'The ID of the asset instance to which the column data in the data asset table belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1232122', + ], + 'RiskLevelId' => [ + 'description' => 'The risk level ID of the column data in the data asset table. Values:'."\n" + .'- **1**: N/A.'."\n" + .'- **2**: S1.'."\n" + .'- **3**: S2.'."\n" + .'- **4**: S3.'."\n" + .'- **5**: S4.'."\n" + ."\n" + .'> A return value <= 1 represents N/A.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'RuleName' => [ + 'description' => 'The name of the sensitive data recognition rule that the column data in the data asset table hits.', + 'type' => 'string', + 'example' => 'name', + ], + 'RuleId' => [ + 'description' => 'The ID of the sensitive data recognition rule that the column data in the data asset table hits.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1004', + ], + 'Sensitive' => [ + 'description' => 'Whether the column data in the data asset table contains sensitive data. Values:'."\n" + ."\n" + .'- true: The column data in the data asset table contains sensitive data.'."\n" + .'- false: The column data in the data asset table does not contain sensitive data.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SensLevelName' => [ + 'description' => 'The sensitivity level name. Values:'."\n" + .'- **N/A**: No sensitive data detected.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'example' => 'S2', + ], + 'InstanceName' => [ + 'description' => 'The name of the asset instance to which the column data in the data asset table belongs.', + 'type' => 'string', + 'example' => 'rm-1234', + ], + 'RiskLevelName' => [ + 'description' => 'The risk level name of the column data in the data asset table. Values:'."\n" + .'- **N/A**: No sensitive data detected.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'example' => 'S1', + ], + 'OdpsRiskLevelName' => [ + 'description' => 'The risk level name of the asset. Values:'."\n" + .'- **N/A**: No sensitive data detected.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'example' => 'S4', + ], + 'Name' => [ + 'description' => 'The name of the column in the data asset table.', + 'type' => 'string', + 'example' => 'obj_id', + ], + 'TableId' => [ + 'description' => 'The ID of the asset table to which the column data in the data asset table belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Id' => [ + 'description' => 'The unique identifier ID of the column in the data asset table.', + 'type' => 'string', + 'example' => '111111', + ], + 'ProductCode' => [ + 'description' => 'The product name to which the column data in the data asset table belongs. Values: **MaxCompute, OSS, ADS, OTS, RDS**, etc.', + 'type' => 'string', + 'example' => 'RDS', + ], + 'RevisionStatus' => [ + 'description' => 'Correction status. Values:'."\n" + .'- 1: Corrected.'."\n" + .'- 0: Not corrected.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RevisionId' => [ + 'description' => 'Correction record ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'ModelTags' => [ + 'description' => 'Data tag list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data tag object.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Data tag ID. Values:'."\n" + .'- **101**: Personal sensitive information'."\n" + .'- **102**: Personal information'."\n" + .'- **107**: General information', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'Data tag name. Values:'."\n" + .'- Personal sensitive information'."\n" + .'- Personal information'."\n" + .'- General information', + 'type' => 'string', + 'example' => 'personal sensitive information', + ], + ], + ], + ], + 'EngineType' => [ + 'description' => 'Engine type. Values:'."\n" + .'- **MySQL**'."\n" + .'- **MariaDB**'."\n" + .'- **Oracle**'."\n" + .'- **PostgreSQL**'."\n" + .'- **SQLServer**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MaskingStatus' => [ + 'description' => 'Column encryption status. Values:'."\n" + ."\n" + .'- **-1**: Not encrypted'."\n" + ."\n" + .'- **1**: Encryption successful'."\n" + ."\n" + .'- **2**: Encryption failed', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'ProductId' => [ + 'description' => 'The ID corresponding to the product name of the data asset. Values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADS'."\n" + .'- **4**: OTS'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'RegionId' => [ + 'description' => 'The region where the asset is located.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1536751124000,\\n \\"TableName\\": \\"it_table\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"OdpsRiskLevelValue\\": 3,\\n \\"InstanceId\\": 1232122,\\n \\"RiskLevelId\\": 4,\\n \\"RuleName\\": \\"name\\",\\n \\"RuleId\\": 1004,\\n \\"Sensitive\\": true,\\n \\"SensLevelName\\": \\"S2\\",\\n \\"InstanceName\\": \\"rm-1234\\",\\n \\"RiskLevelName\\": \\"S1\\",\\n \\"OdpsRiskLevelName\\": \\"S4\\",\\n \\"Name\\": \\"obj_id\\",\\n \\"TableId\\": 123,\\n \\"Id\\": \\"111111\\",\\n \\"ProductCode\\": \\"RDS\\",\\n \\"RevisionStatus\\": 1,\\n \\"RevisionId\\": 12,\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"personal sensitive information\\"\\n }\\n ],\\n \\"EngineType\\": \\"MySQL\\",\\n \\"MaskingStatus\\": -1,\\n \\"ProductId\\": 5,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Data in Columns of Data Assets V2', + 'translator' => 'machine', + ], + 'DescribeOssObjects' => [ + 'summary' => 'Queries Object Storage Service (OSS) objects that you authorize Data Security Center (DSC) to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82058', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The search keyword. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the OSS object. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule that the OSS object hits.'."\n" + ."\n" + .'> You can call the **DescribeRules** operation to query the ID of the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1222', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the OSS object belongs.'."\n" + ."\n" + .'> You can call the **DescribeInstances** operation to query the instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ins-2222', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the data asset resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'LastScanTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1536751124000', + ], + ], + [ + 'name' => 'LastScanTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the last scan. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1536751124000', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the industry-specific rule template.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FileCategoryCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the file type.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'When you query data by page, use the `Marker` parameter to query the data that follows the `Marker` value.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1754786235714378752', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Marker' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'NextMarker' => [ + 'description' => 'The ID value from which the next page of results starts.'."\n" + ."\n" + .'> This parameter is returned only when the `Truncated` parameter is set to `true`.'."\n", + 'type' => 'string', + 'example' => '1754786235714378752', + ], + 'Truncated' => [ + 'description' => 'Indicates whether the queried entries are truncated. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Items' => [ + 'description' => 'The OSS objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The OSS object.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance to which the OSS object belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1232122', + ], + 'CategoryName' => [ + 'description' => 'The name of the file type.'."\n", + 'type' => 'string', + 'example' => 'MP4 file'."\n", + ], + 'RiskLevelId' => [ + 'description' => 'The ID of the sensitivity level of the OSS object. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RegionId' => [ + 'description' => 'The region ID of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'cn-***', + ], + 'FileId' => [ + 'description' => 'The file ID of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'file-22***', + ], + 'Size' => [ + 'description' => 'The size of the file. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'BucketName' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'example' => 'oss-duplicate-***', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the OSS object.'."\n", + 'type' => 'string', + 'example' => 'Medium sensitivity level'."\n", + ], + 'Category' => [ + 'description' => 'The type of the OSS object. Valid values include **900001**, **800015**, or **800005**, which indicates the MP4 file, PDF file, or OSS configuration file, respectively.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '900001', + ], + 'Name' => [ + 'description' => 'The name of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'obj_id', + ], + 'RuleCount' => [ + 'description' => 'The number of rules that are hit.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SensitiveCount' => [ + 'description' => 'The number of fields that are hit.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Id' => [ + 'description' => 'The ID of the OSS object.'."\n", + 'type' => 'string', + 'example' => '17383', + ], + 'RuleList' => [ + 'description' => 'The rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The search keyword. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'example' => 'ID card'."\n", + ], + 'RiskLevelId' => [ + 'description' => 'The ID of the sensitivity level of the OSS object. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Count' => [ + 'description' => 'The number of times that the rule is hit.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + 'FileCategoryCode' => [ + 'description' => 'The code of the file type.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FileCategoryName' => [ + 'description' => 'The name of the file type.'."\n", + 'type' => 'string', + 'example' => 'text file', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the file was last modified.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1536751124000', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"PageSize\\": 12,\\n \\"TotalCount\\": 1,\\n \\"Marker\\": \\"-1\\",\\n \\"NextMarker\\": \\"1754786235714378752\\",\\n \\"Truncated\\": false,\\n \\"Items\\": [\\n {\\n \\"InstanceId\\": 1232122,\\n \\"CategoryName\\": \\"MP4视频文件\\",\\n \\"RiskLevelId\\": 2,\\n \\"RegionId\\": \\"cn-***\\",\\n \\"FileId\\": \\"file-22***\\",\\n \\"Size\\": 20,\\n \\"BucketName\\": \\"oss-duplicate-***\\",\\n \\"RiskLevelName\\": \\"中等风险等级\\",\\n \\"Category\\": 900001,\\n \\"Name\\": \\"obj_id\\",\\n \\"RuleCount\\": 100,\\n \\"SensitiveCount\\": 50,\\n \\"Id\\": \\"17383\\",\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"身份证\\",\\n \\"RiskLevelId\\": 2,\\n \\"Count\\": 100\\n }\\n ],\\n \\"FileCategoryCode\\": 1,\\n \\"FileCategoryName\\": \\"text file\\",\\n \\"LastModifiedTime\\": 1536751124000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeOssObjectsResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n <PageSize>12</PageSize>\\n <TotalCount>1</TotalCount>\\n <Items>\\n <InstanceId>1232122</InstanceId>\\n <CategoryName>MP4视频文件</CategoryName>\\n <RiskLevelId>2</RiskLevelId>\\n <RegionId>cn-***</RegionId>\\n <FileId>file-22***</FileId>\\n <Size>20</Size>\\n <BucketName>oss-duplicate-***</BucketName>\\n <RiskLevelName>中等风险等级</RiskLevelName>\\n <Category>900001</Category>\\n <Name>obj_id</Name>\\n <RuleCount>100</RuleCount>\\n <SensitiveCount>50</SensitiveCount>\\n <Id>17383</Id>\\n <RuleList>\\n <Name>身份证</Name>\\n <RiskLevelId>2</RiskLevelId>\\n <Count>100</Count>\\n </RuleList>\\n </Items>\\n</DescribeOssObjectsResponse>","errorExample":""}]', + 'title' => 'DescribeOssObjects', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeOssObjectDetail' => [ + 'summary' => 'Queries the details of an Object Storage Service (OSS) object that Data Security Center (DSC) is authorized to access.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the OSS object.'."\n" + ."\n" + .'> You can call the [DescribeOssObjects](~~410152~~) operation to obtain the ID of the OSS object.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345213', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'OssObjectDetail' => [ + 'description' => 'The details of the OSS object.'."\n", + 'type' => 'object', + 'properties' => [ + 'CategoryName' => [ + 'description' => 'The type of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'Excel file'."\n", + ], + 'Name' => [ + 'description' => 'The name of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'obj_id', + ], + 'BucketName' => [ + 'description' => 'The name of the OSS bucket to which the OSS object belongs.'."\n", + 'type' => 'string', + 'example' => 'bucke***', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the OSS object.'."\n", + 'type' => 'string', + 'example' => 'Medium sensitivity level'."\n", + ], + 'RegionId' => [ + 'description' => 'The region ID of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'cn-***', + ], + 'RuleList' => [ + 'description' => 'A list of the sensitive data detection rules that the OSS object hits.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the sensitive data detection rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the OSS object.'."\n", + 'type' => 'string', + 'example' => 'Medium sensitivity level'."\n", + ], + 'CategoryName' => [ + 'description' => 'The type of the OSS object.'."\n", + 'type' => 'string', + 'example' => 'Excel file'."\n", + ], + 'RiskLevelId' => [ + 'description' => 'The ID of the sensitivity level of the OSS object.'."\n" + ."\n" + .'* **1**: No sensitive data is detected.'."\n" + .'* **2**: indicates the low sensitivity level.'."\n" + .'* **3**: indicates the medium sensitivity level.'."\n" + .'* **4**: indicates the high sensitivity level.'."\n" + .'* **5**: indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Count' => [ + 'description' => 'The number of times that the OSS object hits the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RuleName' => [ + 'description' => 'The name of the sensitive data detection rule.'."\n", + 'type' => 'string', + 'example' => '\\*\\*\\* rule'."\n", + ], + 'ModelTags' => [ + 'description' => 'A list of tags for data that hits the recognition model.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The tag ID.'."\n" + ."\n" + .'* **101**: sensitive personal information'."\n" + .'* **102**: personal information'."\n" + .'* **103**: important information'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'The tag name.'."\n" + ."\n" + .'* Sensitive personal information'."\n" + .'* Personal information'."\n" + .'* Important information'."\n", + 'type' => 'string', + 'example' => 'personal sensitive data', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"OssObjectDetail\\": {\\n \\"CategoryName\\": \\"Excel\\",\\n \\"Name\\": \\"obj_id\\",\\n \\"BucketName\\": \\"bucke***\\",\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"RegionId\\": \\"cn-***\\",\\n \\"RuleList\\": [\\n {\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"CategoryName\\": \\"Excel\\",\\n \\"RiskLevelId\\": 2,\\n \\"Count\\": 2,\\n \\"RuleName\\": \\"name\\",\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"personal sensitive data\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeOssObjectDetail>\\r\\n\\t<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\r\\n\\t<OssObjectDetail>\\r\\n\\t\\t<RegionId>cn-***</RegionId>\\r\\n\\t\\t<BucketName>bucke***</BucketName>\\r\\n\\t\\t<RiskLevelName>中等风险等级</RiskLevelName>\\r\\n\\t\\t<Id>17383</Id>\\r\\n\\t\\t<RiskLevelId>2</RiskLevelId>\\r\\n\\t\\t<CategoryName>Excel文件</CategoryName>\\r\\n\\t\\t<Name>obj_id</Name>\\r\\n\\t\\t<RuleList>\\r\\n\\t\\t\\t<RuleName>***规则</RuleName>\\r\\n\\t\\t\\t<Count>10</Count>\\r\\n\\t\\t</RuleList>\\r\\n\\t</OssObjectDetail>\\r\\n</DescribeOssObjectDetail>\\t\\r\\n","errorExample":""}]', + 'title' => 'DescribeOssObjectDetail', + 'description' => 'You can call this operation to query the details of an Object Storage Service (OSS) object. This helps you locate sensitive data detected in OSS.'."\n" + ."\n" + .'## [](#)Precautions'."\n" + ."\n" + .'The DescribeOssObjectDetail operation is chagned to DescribeOssObjectDetailV2. We recommend that you call the DescribeOssObjectDetailV2 operation when you develop your applications.'."\n" + ."\n" + .'## [](#qps)Limits'."\n" + ."\n" + .'Each Alibaba Cloud account can call this operation up to 10 times per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeOssObjectDetailV2' => [ + 'summary' => 'Call this interface to query the details of a single storage object in OSS that is authorized by the Data Security Center.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '186152', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the language type for request and response messages. The default value is **zh_cn**. Values:'."\n" + ."\n" + .'- **zh_cn**: Simplified Chinese'."\n" + .'- **en_us**: English (US)', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier ID of the OSS storage object.'."\n" + ."\n" + .'> Call the [DescribeOssObjects](~~410152~~) interface to get the ID.', + 'type' => 'string', + 'required' => false, + 'example' => '12300', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service region ID, i.e., the region ID where the Bucket is located.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket name.', + 'type' => 'string', + 'required' => false, + 'example' => 'sddp-api-scan-demo', + ], + ], + [ + 'name' => 'ObjectKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The full file name of the file stored on OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'dir1/test.png', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Industry template ID.'."\n" + .'> You can obtain the industry template ID by calling the [DescribeCategoryTemplateList](~~2399296~~) interface.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'OssObjectDetail' => [ + 'description' => 'Detailed information about the OSS storage object.', + 'type' => 'object', + 'properties' => [ + 'CategoryName' => [ + 'description' => 'The major category of the model.', + 'type' => 'string', + 'example' => 'Excel file', + ], + 'Name' => [ + 'description' => 'OSS storage object name.', + 'type' => 'string', + 'example' => 'dir1/test.png', + ], + 'BucketName' => [ + 'description' => 'The name of the Bucket to which the OSS storage object belongs.', + 'type' => 'string', + 'example' => 'sddp-api-scan-demo', + ], + 'RiskLevelName' => [ + 'description' => 'The risk level name of the OSS storage object.', + 'type' => 'string', + 'example' => 'S2', + ], + 'RegionId' => [ + 'description' => 'The region ID to which the OSS storage object belongs.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RuleList' => [ + 'description' => 'A list of sensitive data recognition rules hit by the OSS storage object.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the sensitive data recognition rule hit.', + 'type' => 'object', + 'properties' => [ + 'RiskLevelName' => [ + 'description' => 'The risk level name of the OSS storage object.', + 'type' => 'string', + 'example' => 'S2', + ], + 'CategoryName' => [ + 'description' => 'The major category of the model.', + 'type' => 'string', + 'example' => 'Excel', + ], + 'RiskLevelId' => [ + 'description' => 'The risk level ID of the OSS storage object.'."\n" + .'- **1**: No sensitive data detected.'."\n" + .'- **2**: Level 1 sensitive data.'."\n" + .'- **3**: Level 2 sensitive data.'."\n" + .'- **4**: Level 3 sensitive data.'."\n" + .'- **5**: Level 4 sensitive data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Count' => [ + 'description' => 'The number of times the sensitive data recognition rule was hit.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RuleName' => [ + 'description' => 'The name of the sensitive data recognition rule that was hit.', + 'type' => 'string', + 'example' => 'name', + ], + 'ModelTags' => [ + 'description' => 'List of data tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data tag object.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'ID of the data label for the recognition model.'."\n" + .'- **101**: Personal sensitive information.'."\n" + .'- **102**: Personal information.'."\n" + .'- **103**: Important data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'Name of the data label for the recognition model.'."\n" + .'- Personal sensitive information.'."\n" + .'- Personal information.'."\n" + .'- Important data.', + 'type' => 'string', + 'example' => 'personal sensitive data'."\n", + ], + ], + ], + ], + ], + ], + ], + 'FileCategoryName' => [ + 'description' => 'File type.', + 'type' => 'string', + 'example' => 'Text file', + ], + 'Size' => [ + 'description' => 'File size. Unit: Byte.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'ObjectAcl' => [ + 'description' => 'OSS Object ACL', + 'type' => 'string', + 'example' => 'private', + ], + 'ModelTagIds' => [ + 'description' => 'Data labels, separated by commas. Values:'."\n" + .'- **101**: Personal Sensitive Information.'."\n" + .'- **102**: Personal Information.'."\n" + .'- **107**: General Information.', + 'type' => 'string', + 'example' => '101,102', + ], + 'Id' => [ + 'description' => 'The unique ID of the OSS object.', + 'type' => 'string', + 'example' => '1757262735738932224', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the OSS object. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"OssObjectDetail\\": {\\n \\"CategoryName\\": \\"敏感图片信息\\",\\n \\"Name\\": \\"dir1/test.png\\",\\n \\"BucketName\\": \\"sddp-api-scan-demo\\",\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RuleList\\": [\\n {\\n \\"RiskLevelName\\": \\"S2\\",\\n \\"CategoryName\\": \\"敏感图片信息\\",\\n \\"RiskLevelId\\": 3,\\n \\"Count\\": 2,\\n \\"RuleName\\": \\"身份证\\",\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"个人敏感信息\\"\\n }\\n ]\\n }\\n ],\\n \\"FileCategoryName\\": \\"图像文件\\",\\n \\"Size\\": 1024,\\n \\"ObjectAcl\\": \\"private\\",\\n \\"ModelTagIds\\": \\"101,102\\",\\n \\"Id\\": \\"1757262735738932224\\",\\n \\"RiskLevelId\\": 4\\n }\\n}","type":"json"}]', + 'title' => 'DescribeOssObjectDetailV2', + 'description' => 'This interface is generally used to query the detailed information of OSS storage objects, which facilitates the accurate positioning of sensitive OSS assets.', + 'translator' => 'machine', + ], + 'DescribePackages' => [ + 'summary' => 'Queries information about the MaxCompute packages that Data Security Center (DSC) is authorized to access. The information includes the names of MaxCompute packages, the accounts of MaxCompute package owners, and the sensitivity levels of MaxCompute packages.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddp2CRSZ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The search keyword. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service to which the package belongs.'."\n" + ."\n" + .'> You can call the **DescribeDataAssets** operation to query the ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2566600', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the package. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sensitive data detection rule that the package hits.'."\n" + ."\n" + .'> You can call the **DescribeRules** operation to query the ID of the sensitive data detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '266666', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the package belongs.'."\n" + ."\n" + .'> You can call the **DescribeInstances** operation to query the ID of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12321', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'description' => 'An array that consists of the information about the packages.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The point in time when the MaxCompute package was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1536751124000', + ], + 'Sensitive' => [ + 'description' => 'Indicates whether the package contains sensitive data. Valid values:'."\n" + ."\n" + .'* true: yes'."\n" + .'* false: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => 'The account of the user that owns the package.'."\n", + 'type' => 'string', + 'example' => 'cou-2221', + ], + 'RiskLevelName' => [ + 'description' => 'The name of the sensitivity level for the package.'."\n", + 'type' => 'string', + 'example' => 'Highest sensitivity level'."\n", + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance to which the package belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223453332', + ], + 'TotalCount' => [ + 'description' => 'The total volume of data in the package. For example, the value can be the total number of tables in the MaxCompute package.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '321', + ], + 'Name' => [ + 'description' => 'The name of the package.'."\n", + 'type' => 'string', + 'example' => 'gxdata', + ], + 'SensitiveCount' => [ + 'description' => 'The total volume of sensitive data in the package. For example, the value can be the total number of sensitive tables in the MaxCompute package.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the package. Valid values:'."\n" + ."\n" + .'* **1**: N/A, which indicates that no sensitive data is detected.'."\n" + .'* **2**: S1, which indicates the low sensitivity level.'."\n" + .'* **3**: S2, which indicates the medium sensitivity level.'."\n" + .'* **4**: S3, which indicates the high sensitivity level.'."\n" + .'* **5**: S4, which indicates the highest sensitivity level.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Id' => [ + 'description' => 'The ID of the package.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111111', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1536751124000,\\n \\"Sensitive\\": true,\\n \\"Owner\\": \\"cou-2221\\",\\n \\"RiskLevelName\\": \\"最高风险等级\\",\\n \\"InstanceId\\": 223453332,\\n \\"TotalCount\\": 321,\\n \\"Name\\": \\"gxdata\\",\\n \\"SensitiveCount\\": 123,\\n \\"RiskLevelId\\": 4,\\n \\"Id\\": 111111\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribePackages>\\r\\n\\t<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\r\\n\\t<TotalCount>4</TotalCount>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<CurrentPage>1</CurrentPage>\\r\\n\\t<Items>\\r\\n\\t\\t<Owner>dtdep-239-******</Owner>\\r\\n\\t\\t<RiskLevelId>2</RiskLevelId>\\r\\n\\t\\t<RiskLevelName>中等风险等级</RiskLevelName>\\r\\n\\t\\t<DepartName>***DemoCenter</DepartName>\\r\\n\\t\\t<Name>gxdata</Name>\\r\\n\\t\\t<CreationTime>1536751124000</CreationTime>\\r\\n\\t\\t<Sensitive>true</Sensitive>\\r\\n\\t\\t<Id>268</Id>\\r\\n\\t\\t<InstanceId>1</InstanceId>\\r\\n\\t</Items>\\r\\n</DescribePackages>\\t\\r\\n","errorExample":""}]', + 'title' => 'DescribePackages', + 'description' => 'You can call this operation to query MaxCompute packages that are scanned by DSC. This helps you search for MaxCompute packages and view the summary of MaxCompute packages.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'extraInfo' => ' ', + ], + 'DescribeCategoryTemplateList' => [ + 'summary' => 'Call this interface to query the list of industry templates.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81997', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the language type for the request and response messages, default is **zh_cn**.'."\n" + .'Values:'."\n" + ."\n" + .'- **zh_cn**: Chinese (Simplified)'."\n" + .'- **en_us**: English (United States)', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the number of items per page. Default value is **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number for paginated queries. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'UsageScenario', + 'in' => 'query', + 'schema' => [ + 'description' => 'API call scenario, default is **null**.'."\n" + .'Values:'."\n" + .'- **null**: Old version'."\n" + .'- **0**: Old version'."\n" + .'- **1**: New version', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Return value object.', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'Page number for paginated queries. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', + 'type' => 'string', + 'example' => '8491DBFD-48C0-4E11-B6FC-6F38921244A9', + ], + 'PageSize' => [ + 'description' => 'Number of items per page in a paginated query. Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'Total number of data items returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'description' => 'List of industry templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'Industry template object.', + 'type' => 'object', + 'properties' => [ + 'CurrentRiskLevel' => [ + 'description' => 'Current risk level ID.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Status' => [ + 'description' => 'Status of the industry template. Values:'."\n" + .'- **0**: Closed status.'."\n" + .'- **1**: Enabled status, user\'s current main template.'."\n" + .'- **2**: Active status, both enabled and active templates can be applied to recognition tasks.'."\n" + .'- **3**: General recognition model template status.'."\n" + ."\n" + .'> Templates in enabled and active status can be used as the industry template ID parameter for [DescribeDataObjects](~~2399253~~).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => 'Type of the industry template.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'SupportEdit' => [ + 'description' => 'Whether the industry template supports editing. Values:'."\n" + .'- **0**: Not supported.'."\n" + .'- **1**: Supported.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxCategoryLevel' => [ + 'description' => 'Maximum category level.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Name' => [ + 'description' => 'Name of the industry template.', + 'type' => 'string', + 'example' => 'built-in template', + ], + 'MaxRiskLevel' => [ + 'description' => 'Maximum risk level ID.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Id' => [ + 'description' => 'Unique identifier ID of the industry template.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Description' => [ + 'description' => 'Description information of the industry template.', + 'type' => 'string', + 'example' => 'description', + ], + 'GmtCreate' => [ + 'description' => 'Industry template creation time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582992000000', + ], + 'GmtModified' => [ + 'description' => 'Industry template modification time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545277010000', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"8491DBFD-48C0-4E11-B6FC-6F38921244A9\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Items\\": [\\n {\\n \\"CurrentRiskLevel\\": 5,\\n \\"Status\\": 1,\\n \\"Type\\": 6,\\n \\"SupportEdit\\": 0,\\n \\"MaxCategoryLevel\\": 2,\\n \\"Name\\": \\"built-in template\\",\\n \\"MaxRiskLevel\\": 5,\\n \\"Id\\": 1,\\n \\"Description\\": \\"description\\",\\n \\"GmtCreate\\": 1582992000000,\\n \\"GmtModified\\": 1545277010000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Industry Template List', + 'translator' => 'machine', + ], + 'DescribeCategoryTemplateRuleList' => [ + 'summary' => 'Queries rules in a classification template by page.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81998', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the rule. Default value: **null**. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n" + .'* **null**: all states'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitivity level of the data that is not compliant with the rule. Valid values: **1** to **11**. Default value: **null**.'."\n" + ."\n" + .'* **1**: No sensitive data is detected.'."\n" + .'* **2**: specifies the S1 sensitivity level.'."\n" + .'* **3**: specifies the S2 sensitivity level.'."\n" + .'* **4**: specifies the S3 sensitivity level.'."\n" + .'* **5**: specifies the S4 sensitivity level.'."\n" + .'* **6**: specifies the S5 sensitivity level.'."\n" + .'* **7**: specifies the S6 sensitivity level.'."\n" + .'* **8**: specifies the S7 sensitivity level.'."\n" + .'* **9**: specifies the S8 sensitivity level.'."\n" + .'* **10**: specifies the S9 sensitivity level.'."\n" + .'* **11**: specifies the S10 sensitivity level.'."\n" + .'* **null**: specifies all preceding sensitivity levels.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '136082B3-B21F-5E9D-B68E-991FFD205D24', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of rules in the template.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Items' => [ + 'description' => 'The list of rules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the rule. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n" + .'* **null**: all states'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IdentificationScope' => [ + 'description' => 'The scan scope of the rule. The value is a JSON array of the STRING type. Each element in a JSON array indicates a scan scope that contains the following fields:'."\n" + ."\n" + .'* **Asset**: the data asset type. Valid values: RDS, DRDS, PolarDB, OTS, ADB, and OceanBase. The value is of the STRING type.'."\n" + ."\n" + .'* **Content**: the scan scope. The value is of the STRING type. Each element in a JSON array indicates a scan scope that contains the following fields:'."\n" + ."\n" + .' * **Range**: the matching condition. Valid values: Instance, database, table, column, project, bucket, and object. The value project is valid only for data assets in MaxCompute. The values bucket and object are valid only for data assets in Object Storage Service (OSS). The value of this parameter is of the STRING type.'."\n" + .' * **Operator**: the operator. Valid values: equals, regex, prefix, and suffix. The operator equals indicates a full match. The operator regex indicates a match by regular expression. The operator prefix indicates a match by prefix. The operator suffix indicates a match by suffix.'."\n" + .' * **Value**: the matching content. The value is of the STRING type.'."\n", + 'type' => 'string', + 'example' => '[{"Asset":"RDS","Content":[{"Range":"database","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"project","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]}]', + ], + 'RiskLevelId' => [ + 'description' => 'The sensitivity level of the data that is not compliant with the rule. Valid values: **1** to **11**.'."\n" + ."\n" + .'* **1**: No sensitive data is detected.'."\n" + .'* **2**: indicates the S1 sensitivity level.'."\n" + .'* **3**: indicates the S2 sensitivity level.'."\n" + .'* **4**: indicates the S3 sensitivity level.'."\n" + .'* **5**: indicates the S4 sensitivity level.'."\n" + .'* **6**: indicates the S5 sensitivity level.'."\n" + .'* **7**: indicates the S6 sensitivity level.'."\n" + .'* **8**: indicates the S7 sensitivity level.'."\n" + .'* **9**: indicates the S8 sensitivity level.'."\n" + .'* **10**: indicates the S9 sensitivity level.'."\n" + .'* **11**: indicates the S10 sensitivity level.'."\n" + .'* **null**: indicates all preceding sensitivity levels.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Description' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'example' => 'Rule for identifying ID card numbers'."\n", + ], + 'IdentificationRuleIds' => [ + 'description' => 'The IDs of sensitive data types. Multiple IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '1001,1002', + ], + 'Name' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'example' => 'ID card number'."\n", + ], + 'Id' => [ + 'description' => 'The unique ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"136082B3-B21F-5E9D-B68E-991FFD205D24\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"Items\\": [\\n {\\n \\"Status\\": 1,\\n \\"IdentificationScope\\": \\"[{\\\\\\"Asset\\\\\\":\\\\\\"RDS\\\\\\",\\\\\\"Content\\\\\\":[{\\\\\\"Range\\\\\\":\\\\\\"database\\\\\\",\\\\\\"Operator\\\\\\":\\\\\\"regex\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"register\\\\\\"}]},{\\\\\\"Asset\\\\\\":\\\\\\"RDS\\\\\\",\\\\\\"Content\\\\\\":[{\\\\\\"Range\\\\\\":\\\\\\"table\\\\\\",\\\\\\"Operator\\\\\\":\\\\\\"regex\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"register\\\\\\"}]},{\\\\\\"Asset\\\\\\":\\\\\\"RDS\\\\\\",\\\\\\"Content\\\\\\":[{\\\\\\"Range\\\\\\":\\\\\\"column\\\\\\",\\\\\\"Operator\\\\\\":\\\\\\"regex\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"register\\\\\\"}]},{\\\\\\"Asset\\\\\\":\\\\\\"ODPS\\\\\\",\\\\\\"Content\\\\\\":[{\\\\\\"Range\\\\\\":\\\\\\"project\\\\\\",\\\\\\"Operator\\\\\\":\\\\\\"regex\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"register\\\\\\"}]},{\\\\\\"Asset\\\\\\":\\\\\\"ODPS\\\\\\",\\\\\\"Content\\\\\\":[{\\\\\\"Range\\\\\\":\\\\\\"table\\\\\\",\\\\\\"Operator\\\\\\":\\\\\\"regex\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"register\\\\\\"}]},{\\\\\\"Asset\\\\\\":\\\\\\"ODPS\\\\\\",\\\\\\"Content\\\\\\":[{\\\\\\"Range\\\\\\":\\\\\\"column\\\\\\",\\\\\\"Operator\\\\\\":\\\\\\"regex\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"register\\\\\\"}]}]\\",\\n \\"RiskLevelId\\": 2,\\n \\"Description\\": \\"用于识别身份证号的模板规则\\",\\n \\"IdentificationRuleIds\\": \\"1001,1002\\",\\n \\"Name\\": \\"身份证号\\",\\n \\"Id\\": 100\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCategoryTemplateRuleListResponse>\\n <CurrentPage>1</CurrentPage>\\n <RequestId>136082B3-B21F-5E9D-B68E-991FFD205D24</RequestId>\\n <PageSize>10</PageSize>\\n <TotalCount>10</TotalCount>\\n <Items>\\n <Status>1</Status>\\n <IdentificationScope>[{\\"Asset\\":\\"RDS\\",\\"Content\\":[{\\"Range\\":\\"database\\",\\"Operator\\":\\"regex\\",\\"Value\\":\\"register\\"}]},{\\"Asset\\":\\"RDS\\",\\"Content\\":[{\\"Range\\":\\"table\\",\\"Operator\\":\\"regex\\",\\"Value\\":\\"register\\"}]},{\\"Asset\\":\\"RDS\\",\\"Content\\":[{\\"Range\\":\\"column\\",\\"Operator\\":\\"regex\\",\\"Value\\":\\"register\\"}]},{\\"Asset\\":\\"ODPS\\",\\"Content\\":[{\\"Range\\":\\"project\\",\\"Operator\\":\\"regex\\",\\"Value\\":\\"register\\"}]},{\\"Asset\\":\\"ODPS\\",\\"Content\\":[{\\"Range\\":\\"table\\",\\"Operator\\":\\"regex\\",\\"Value\\":\\"register\\"}]},{\\"Asset\\":\\"ODPS\\",\\"Content\\":[{\\"Range\\":\\"column\\",\\"Operator\\":\\"regex\\",\\"Value\\":\\"register\\"}]}]</IdentificationScope>\\n <RiskLevelId>2</RiskLevelId>\\n <Description>用于识别身份证号的模板规则</Description>\\n <IdentificationRuleIds>1001,1002</IdentificationRuleIds>\\n <Name>身份证号</Name>\\n <Id>100</Id>\\n </Items>\\n</DescribeCategoryTemplateRuleListResponse>","errorExample":""}]', + 'title' => 'DescribeCategoryTemplateRuleList', + 'description' => 'You can call this operation to query rules in a classification template.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeTemplateAllRules' => [ + 'summary' => 'Call this interface to query all models list of industry templates.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82084', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language type for the request and response, default is **zh_cn**. Values:'."\n" + .'- **zh_cn**: Chinese.'."\n" + .'- **en_us**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Industry template ID.'."\n" + ."\n" + .'> You can obtain the industry template ID by calling [DescribeCategoryTemplateList](~~2399296~~). If this parameter is not provided, the model list of the primary template will be returned by default.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', + 'type' => 'string', + 'example' => '769FB3C1-F4C9-4******', + ], + 'RuleList' => [ + 'description' => 'List of model objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'Model object.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'Model name.', + 'type' => 'string', + 'example' => 'Model Name', + ], + 'Id' => [ + 'description' => 'Unique ID of the model.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '376', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-4******\\",\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"Model Name\\",\\n \\"Id\\": 376\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query All Models List of Industry Templates', + 'translator' => 'machine', + ], + 'DescribeDocTypes' => [ + 'summary' => 'Queries a list of OSS object types that can be identified.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUNEZP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-4******', + ], + 'DocTypeList' => [ + 'description' => 'A list of OSS object types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the object type.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + 'Name' => [ + 'description' => 'The name of the object type.'."\n", + 'type' => 'string', + 'example' => 'C/C++ Source Code', + ], + 'Id' => [ + 'description' => 'The ID of the object type.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-4******\\",\\n \\"DocTypeList\\": [\\n {\\n \\"Code\\": 100001,\\n \\"Name\\": \\"C/C++ Source Code\\",\\n \\"Id\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDocTypes', + ], + 'DescribeDataObjects' => [ + 'summary' => 'Paginated Query of Data Catalog Objects', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '149455', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language type for request and response messages, default is **zh_cn**. Values:'."\n" + .'- **zh_cn**: Chinese.'."\n" + .'- **en_us**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the maximum number of data asset instances to display per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number for the paginated query. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'It is recommended to fill in the list of product IDs to be queried, separated by commas. Values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis'."\n" + ."\n" + .'> OSS is mutually exclusive with other products, meaning if OSS is included in the query, no other products can be listed; by default, non-OSS products are queried.', + 'type' => 'string', + 'required' => false, + 'example' => '1,5', + ], + ], + [ + 'name' => 'ParentCategoryIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of parent category IDs for the template to be queried, separated by commas.', + 'type' => 'string', + 'required' => false, + 'example' => '234,236,238', + ], + ], + [ + 'name' => 'QueryName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyword for the data object to be queried.', + 'type' => 'string', + 'required' => false, + 'example' => 't_sddp_selfmysql_pers0', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region where the asset is located. Values:'."\n" + .'- **cn-beijing**: North China 2 (Beijing).'."\n" + .'- **cn-zhangjiakou**: North China 3 (Zhangjiakou).'."\n" + .'- **cn-huhehaote**: North China 5 (Hohhot).'."\n" + .'- **cn-hangzhou**: East China 1 (Hangzhou).'."\n" + .'- **cn-shanghai**: East China 2 (Shanghai).'."\n" + .'- **cn-shenzhen**: South China 1 (Shenzhen).'."\n" + .'- **cn-hongkong**: Hong Kong, China.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Industry template ID.'."\n" + ."\n" + .'> You can obtain the industry template identifier ID by calling [DescribeCategoryTemplateList](~~2399296~~).', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the data domain to which the data asset belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ModelTagIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'Data labels to be queried, separated by commas. Values:'."\n" + .'- **101**: Personal Sensitive Information.'."\n" + .'- **102**: Personal Information.'."\n" + .'- **107**: General Information.', + 'type' => 'string', + 'required' => false, + 'example' => '101,102', + ], + ], + [ + 'name' => 'RiskLevels', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the risk levels of the data assets to be queried, separated by commas if multiple.'."\n" + .'- **2**: S1, low risk level.'."\n" + .'- **3**: S2, medium risk level.'."\n" + .'- **4**: S3, high risk level.'."\n" + .'- **5**: S4, highest risk level.', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyword for the asset instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => '8vb54hn2g9j191ddz', + ], + ], + [ + 'name' => 'ModelIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'Model IDs of the industry template, separated by commas.'."\n" + .'> You can obtain the industry template model identifier ID by calling [DescribeTemplateAllRules](~~2536491~~).', + 'type' => 'string', + 'required' => false, + 'example' => '101', + ], + ], + [ + 'name' => 'FileType', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS file types that are supported for recognition.'."\n" + ."\n" + .'> You can obtain the supported OSS file types by calling [DescribeDocTypes](~~2536492~~), using the Code field value from the response. This parameter is only valid for querying OSS-type assets.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'FileCategoryCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'File category code.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MemberAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Member account ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '**********8103', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'When performing a paginated query, set the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of this call request is a unique identifier generated by Alibaba Cloud for the request, which can be used to troubleshoot and locate issues.', + 'type' => 'string', + 'example' => 'E6F6460E-4330-549A-BD89-C183FB17571E', + ], + 'PageSize' => [ + 'description' => 'When performing a paginated query, this sets the maximum number of data asset instances to display per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of query results.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'Items' => [ + 'description' => 'List of data objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of data objects.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the data object.', + 'type' => 'string', + 'example' => 't_sddp_selfmysql_pers0', + ], + 'Id' => [ + 'description' => 'The unique identifier ID of the data object.', + 'type' => 'string', + 'example' => '20000', + ], + 'TemplateId' => [ + 'description' => 'Industry template ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ProductId' => [ + 'description' => 'The ID corresponding to the product name that the data object belongs to. Values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'InstanceDescription' => [ + 'description' => 'The instance description of the data object.', + 'type' => 'string', + 'example' => 'instance description', + ], + 'ProductCode' => [ + 'description' => 'The product name that the data object belongs to. Values:'."\n" + .'- **MaxCompute**'."\n" + .'- **OSS**'."\n" + .'- **ADB-MYSQL**'."\n" + .'- **TableStore**'."\n" + .'- **RDS**'."\n" + .'- **SELF_DB**'."\n" + .'- **PolarDB-X**'."\n" + .'- **PolarDB**'."\n" + .'- **ADB-PG**'."\n" + .'- **OceanBase**'."\n" + .'- **MongoDB**'."\n" + .'- **Redis**', + 'type' => 'string', + 'example' => 'RDS', + ], + 'InstanceId' => [ + 'description' => 'Data asset instance ID.', + 'type' => 'string', + 'example' => 'rm-12*****', + ], + 'LastScanTime' => [ + 'description' => 'The timestamp of the last scan, in milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687676649830', + ], + 'SensitiveCount' => [ + 'description' => 'Number of sensitive data items.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ObjectType' => [ + 'description' => 'The type of the data object.', + 'type' => 'string', + 'example' => 'text type', + ], + 'Path' => [ + 'description' => 'The path of the data object.', + 'type' => 'string', + 'example' => 'rm-12**.db_***', + ], + 'RegionName' => [ + 'description' => 'Region name.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Categories' => [ + 'description' => 'List of industry categories for the sensitive data.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of industry categories for the sensitive data, separated by commas if multiple.', + 'type' => 'string', + 'example' => 'general sensitive information', + ], + ], + 'ModelTags' => [ + 'description' => 'List of data tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of data tags.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Data tag ID. Values:'."\n" + .'- **101**: Personal sensitive information.'."\n" + .'- **102**: Personal information.'."\n" + .'- **107**: General information.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'Data tag name. Values:'."\n" + .'- **Personal sensitive information.**'."\n" + .'- **Personal information.**'."\n" + .'- **General information.**', + 'type' => 'string', + 'example' => 'Personal sensitive information', + ], + ], + ], + ], + 'RuleList' => [ + 'description' => 'List of matched identification models.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of matched identification models.', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => 'Identification model ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'RuleName' => [ + 'description' => 'Identification model name.', + 'type' => 'string', + 'example' => 'name', + ], + 'RiskLevelId' => [ + 'description' => 'Risk level ID for sensitive data identification rules. Values:'."\n" + .'- **1**: N/A: No sensitive data identified.'."\n" + .'- **2**: S1: Level 1 sensitive data.'."\n" + .'- **3**: S2: Level 2 sensitive data.'."\n" + .'- **4**: S3: Level 3 sensitive data.'."\n" + .'- **5**: S4: Level 4 sensitive data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RiskLevelName' => [ + 'description' => 'Risk level name for the data asset table. Values:'."\n" + .'- **N/A**: No sensitive data identified.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'example' => 'S1', + ], + 'RuleCount' => [ + 'description' => 'Number of matched identification models.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '590', + ], + ], + ], + ], + 'ObjectFileCategory' => [ + 'description' => 'File category name.', + 'type' => 'string', + 'example' => 'text file', + ], + 'MemberAccount' => [ + 'description' => 'Member account ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '**********8103', + ], + 'LastModifiedTime' => [ + 'description' => 'Latest file modification time, in milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687676649830', + ], + 'RegionId' => [ + 'description' => 'The region ID to which the OSS storage object belongs.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"E6F6460E-4330-549A-BD89-C183FB17571E\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 21,\\n \\"Items\\": [\\n {\\n \\"Name\\": \\"t_sddp_selfmysql_pers0\\",\\n \\"Id\\": \\"20000\\",\\n \\"TemplateId\\": 1,\\n \\"ProductId\\": 5,\\n \\"InstanceDescription\\": \\"instance description\\",\\n \\"ProductCode\\": \\"RDS\\",\\n \\"InstanceId\\": \\"rm-12*****\\",\\n \\"LastScanTime\\": 1687676649830,\\n \\"SensitiveCount\\": 1,\\n \\"ObjectType\\": \\"text type\\",\\n \\"Path\\": \\"rm-12**.db_***\\",\\n \\"RegionName\\": \\"cn-hangzhou\\",\\n \\"Categories\\": [\\n \\"general sensitive information\\"\\n ],\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"个人敏感信息\\"\\n }\\n ],\\n \\"RuleList\\": [\\n {\\n \\"RuleId\\": 1080,\\n \\"RuleName\\": \\"name\\",\\n \\"RiskLevelId\\": 2,\\n \\"RiskLevelName\\": \\"S1\\",\\n \\"RuleCount\\": 590\\n }\\n ],\\n \\"ObjectFileCategory\\": \\"text file\\",\\n \\"MemberAccount\\": 0,\\n \\"LastModifiedTime\\": 1687676649830,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Data Object List', + 'translator' => 'machine', + ], + 'DescribeDataObjectColumnDetail' => [ + 'summary' => 'View data object column details', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149483', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language type for requests and responses. Default value: **zh_cn**. Values:'."\n" + .'- **zh_cn**: Chinese.'."\n" + .'- **en_us**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the maximum number of data asset instances displayed per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID corresponding to the product name of the data object. Values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the unique identifier ID of the data object to be queried.'."\n" + ."\n" + .'> You can obtain the identifier ID by calling [DescribeDataObjects](~~2399253~~).', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '318248', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Industry template ID.'."\n" + .'> You can obtain the industry template identifier ID by calling [DescribeDataObjects](~~2399253~~).', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'When performing a paginated query, set the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => '8C8036CC-961D-514E-88E8-3088B5A50CA9', + ], + 'PageSize' => [ + 'description' => 'When performing a paginated query, set the maximum number of data asset instances displayed per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of data items in the result.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '61', + ], + 'Items' => [ + 'description' => 'List of identified results for the columns of the data table.', + 'type' => 'array', + 'items' => [ + 'description' => 'Identified result object for the columns of the data table.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => 'Column name.', + 'type' => 'string', + 'example' => 'hide14', + ], + 'DataType' => [ + 'description' => 'Data type of the column.', + 'type' => 'string', + 'example' => 'varchar', + ], + 'ColumnComment' => [ + 'description' => 'Comment on the column.', + 'type' => 'string', + 'example' => 'column comment', + ], + 'PrimaryKey' => [ + 'description' => 'Whether the column is a primary key. Values:'."\n" + ."\n" + .'- **true**: Primary key.'."\n" + .'- **false**: Not a primary key.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => 'Unique identifier ID of the column object.', + 'type' => 'string', + 'example' => '1509415150052786176', + ], + 'RiskLevelId' => [ + 'description' => 'Risk level ID. Values:'."\n" + .'- **1**: N/A: No sensitive data detected.'."\n" + .'- **2**: S1: Level 1 sensitive data.'."\n" + .'- **3**: S2: Level 2 sensitive data.'."\n" + .'- **4**: S3: Level 3 sensitive data.'."\n" + .'- **5**: S4: Level 4 sensitive data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RiskLevelName' => [ + 'description' => 'Risk level name. Possible values:'."\n" + .'- **N/A**: No sensitive data detected.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'example' => 'S1', + ], + 'RuleId' => [ + 'description' => 'ID of the matched identification model.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1004', + ], + 'RuleName' => [ + 'description' => 'Name of the matched identification model.', + 'type' => 'string', + 'example' => 'name', + ], + 'Categories' => [ + 'description' => 'List of industry categories for the sensitive data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Industry category for the sensitive data, multiple categories are separated by commas.', + 'type' => 'string', + 'example' => 'general sensitive information', + ], + ], + 'ModelTags' => [ + 'description' => 'List of data tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data tag object.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'ID corresponding to the data tag name. Possible values:'."\n" + .'- **101**: Personal sensitive information.'."\n" + .'- **102**: Personal information.'."\n" + .'- **107**: General information.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'Data tag name. Possible values:'."\n" + .'- **101**: Personal sensitive information.'."\n" + .'- **102**: Personal information.'."\n" + .'- **107**: General information.', + 'type' => 'string', + 'example' => 'personal sensitive information', + ], + ], + ], + ], + 'EngineType' => [ + 'description' => 'Engine type. Possible values:'."\n" + .'- **MySQL**'."\n" + .'- **MariaDB**'."\n" + .'- **Oracle**'."\n" + .'- **PostgreSQL**'."\n" + .'- **SQLServer**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MaskingStatus' => [ + 'description' => 'Column encryption status. Possible values:'."\n" + ."\n" + .'- **-1**: Not encrypted'."\n" + ."\n" + .'- **1**: Encryption successful'."\n" + ."\n" + .'- **2**: Encryption failed', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'InstanceName' => [ + 'description' => 'Instance name of the data asset table.', + 'type' => 'string', + 'example' => 'rm-1234', + ], + 'TableName' => [ + 'description' => 'Table name.', + 'type' => 'string', + 'example' => 'it_table', + ], + 'RegionId' => [ + 'description' => 'Region where the asset is located.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ProductId' => [ + 'description' => 'ID corresponding to the product name of the data object. Possible values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"8C8036CC-961D-514E-88E8-3088B5A50CA9\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 61,\\n \\"Items\\": [\\n {\\n \\"ColumnName\\": \\"hide14\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"ColumnComment\\": \\"column comment\\",\\n \\"PrimaryKey\\": true,\\n \\"Id\\": \\"1509415150052786176\\",\\n \\"RiskLevelId\\": 2,\\n \\"RiskLevelName\\": \\"S1\\",\\n \\"RuleId\\": 1004,\\n \\"RuleName\\": \\"name\\",\\n \\"Categories\\": [\\n \\"general sensitive information\\"\\n ],\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"personal sensitive information\\"\\n }\\n ],\\n \\"EngineType\\": \\"MySQL\\",\\n \\"MaskingStatus\\": -1,\\n \\"InstanceName\\": \\"rm-1234\\",\\n \\"TableName\\": \\"it_table\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductId\\": 5\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Data Object Column Details', + 'description' => '## Notes'."\n" + .'The DescribeDataObjectColumnDetail interface has been revised to DescribeDataObjectColumnDetailV2. It is recommended that you use the newer version, DescribeDataObjectColumnDetailV2, when developing your application.', + 'translator' => 'machine', + ], + 'DescribeDataObjectColumnDetailV2' => [ + 'summary' => 'View Data Object Column Details V2', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186089', + 'abilityTreeNodes' => [ + 'FEATUREsddp2VFD4T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language type for the request and response messages, default is **zh_cn**. Values:'."\n" + .'- **zh_cn**: Chinese.'."\n" + .'- **en_us**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the maximum number of data asset instances to display per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'When performing a paginated query, set the current page number. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID corresponding to the product name of the data object. Values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the unique identifier ID of the data object to be queried.'."\n" + ."\n" + .'> You can obtain the identifier ID by calling [DescribeDataObjects](~~2399253~~).', + 'type' => 'string', + 'required' => true, + 'example' => '13456723343', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Industry template ID.'."\n" + .'> You can obtain the industry template identifier ID by calling [DescribeDataObjects](~~2399253~~).', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'Page number for paginated queries. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'PageSize' => [ + 'description' => 'When performing a paginated query, set the maximum number of data asset instances to display per page. Default value: **10**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'Total number of data entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '231', + ], + 'Items' => [ + 'description' => 'List of recognition results for the columns in the data table.', + 'type' => 'array', + 'items' => [ + 'description' => 'Recognition result object for the columns in the data table.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => 'Column name.', + 'type' => 'string', + 'example' => 'hide14', + ], + 'DataType' => [ + 'description' => 'Data type of the column.', + 'type' => 'string', + 'example' => 'varchar', + ], + 'ColumnComment' => [ + 'description' => 'Comment for the column.', + 'type' => 'string', + 'example' => 'column comment', + ], + 'PrimaryKey' => [ + 'description' => 'Whether the column is a primary key. Value explanation:'."\n" + ."\n" + .'- **true**: Primary key.'."\n" + .'- **false**: Not a primary key.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => 'Unique identifier ID of the data object.', + 'type' => 'string', + 'example' => '1392973973691383808', + ], + 'RiskLevelId' => [ + 'description' => 'Risk level ID. Values:'."\n" + .'- **1**: N/A: No sensitive data detected.'."\n" + .'- **2**: S1: Level 1 sensitive data.'."\n" + .'- **3**: S2: Level 2 sensitive data.'."\n" + .'- **4**: S3: Level 3 sensitive data.'."\n" + .'- **5**: S4: Level 4 sensitive data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RiskLevelName' => [ + 'description' => 'Risk level name. Values:'."\n" + .'- **N/A**: No sensitive data was identified.'."\n" + .'- **S1**: Level 1 sensitive data.'."\n" + .'- **S2**: Level 2 sensitive data.'."\n" + .'- **S3**: Level 3 sensitive data.'."\n" + .'- **S4**: Level 4 sensitive data.', + 'type' => 'string', + 'example' => 'S1', + ], + 'RuleId' => [ + 'description' => 'The ID of the matched recognition model.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51', + ], + 'RuleName' => [ + 'description' => 'The name of the matched recognition model.', + 'type' => 'string', + 'example' => 'name', + ], + 'Categories' => [ + 'description' => 'List of industry categories for sensitive data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Industry categories for sensitive data, separated by commas if multiple.', + 'type' => 'string', + 'example' => 'general sensitive information', + ], + ], + 'ModelTags' => [ + 'description' => 'List of data tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data tag object.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'ID corresponding to the data tag name. Values:'."\n" + .'- **101**: Personal Sensitive Information.'."\n" + .'- **102**: Personal Information.'."\n" + .'- **107**: General Information.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'Name' => [ + 'description' => 'Data tag name. Values:'."\n" + .'- Personal Sensitive Information.'."\n" + .'- Personal Information.'."\n" + .'- General Information.', + 'type' => 'string', + 'example' => 'personal sensitive information', + ], + ], + ], + ], + 'EngineType' => [ + 'description' => 'Engine type. Values:'."\n" + .'- **MySQL**'."\n" + .'- **MariaDB**'."\n" + .'- **Oracle**'."\n" + .'- **PostgreSQL**'."\n" + .'- **SQLServer**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MaskingStatus' => [ + 'description' => 'Column encryption status. Values:'."\n" + ."\n" + .'- **-1**: Not encrypted'."\n" + ."\n" + .'- **1**: Encryption successful'."\n" + ."\n" + .'- **2**: Encryption failed', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'InstanceName' => [ + 'description' => 'Instance name of the data asset table.', + 'type' => 'string', + 'example' => 'rm-bp17t1htja573l5i8****', + ], + 'TableName' => [ + 'description' => 'Table name.', + 'type' => 'string', + 'example' => 'it_table', + ], + 'RegionId' => [ + 'description' => 'Region where the asset is located.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ProductId' => [ + 'description' => 'ID corresponding to the product name of the data object. Values:'."\n" + .'- **1**: MaxCompute'."\n" + .'- **2**: OSS'."\n" + .'- **3**: ADB-MYSQL'."\n" + .'- **4**: TableStore'."\n" + .'- **5**: RDS'."\n" + .'- **6**: SELF_DB'."\n" + .'- **7**: PolarDB-X'."\n" + .'- **8**: PolarDB'."\n" + .'- **9**: ADB-PG'."\n" + .'- **10**: OceanBase'."\n" + .'- **11**: MongoDB'."\n" + .'- **25**: Redis', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 231,\\n \\"Items\\": [\\n {\\n \\"ColumnName\\": \\"hide14\\",\\n \\"DataType\\": \\"varchar\\",\\n \\"ColumnComment\\": \\"column comment\\",\\n \\"PrimaryKey\\": true,\\n \\"Id\\": \\"1392973973691383808\\",\\n \\"RiskLevelId\\": 2,\\n \\"RiskLevelName\\": \\"S1\\",\\n \\"RuleId\\": 51,\\n \\"RuleName\\": \\"name\\",\\n \\"Categories\\": [\\n \\"general sensitive information\\"\\n ],\\n \\"ModelTags\\": [\\n {\\n \\"Id\\": 101,\\n \\"Name\\": \\"personal sensitive information\\"\\n }\\n ],\\n \\"EngineType\\": \\"MySQL\\",\\n \\"MaskingStatus\\": -1,\\n \\"InstanceName\\": \\"rm-bp17t1htja573l5i8****\\",\\n \\"TableName\\": \\"it_table\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ProductId\\": 5\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Data Object Column Details V2', + 'translator' => 'machine', + ], + 'CreateConfig' => [ + 'summary' => 'Modifies the configurations of a common configuration item for alerts.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '81959', + 'abilityTreeNodes' => [ + 'FEATUREsddpR2D59W', + 'FEATUREsddpCHNP1R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the common configuration item. Valid values:'."\n" + ."\n" + .'* **access_failed_cnt**: the maximum number of access attempts allowed when Data Security Center (DSC) fails to access an unauthorized resource.'."\n" + .'* **access_permission_exprie_max_days**: the maximum idle period allowed for access permissions before an alert is triggered.'."\n" + .'* **log_datasize_avg_days**: the minimum percentage of the volume of logs of a specific type generated on the current day to the average volume of logs generated in the previous 10 days before an alert is triggered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'access_failed_cnt', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the common configuration item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Maximum number of access attempts allowed when DSC fails to access an unauthorized resource: 10'."\n", + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the common configuration item. The meaning of this parameter varies with the value of the Code parameter.'."\n" + ."\n" + .'* If you set the Code parameter to **access_failed_cnt**, the Value parameter specifies the maximum number of access attempts allowed when DSC fails to access an unauthorized resource.'."\n" + .'* If you set the Code parameter to **access_permission_exprie_max_days**, the Value parameter specifies the maximum idle period allowed for access permissions before an alert is triggered.'."\n" + .'* If you set the Code parameter to **log_datasize_avg_days**, the Value parameter specifies the minimum percentage of the volume of logs of a specific type generated on the current day to the average amount of logs generated in the previous 10 days before an alert is triggered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.', + 'example' => '1', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '39.170.XX.XX', + 'description' => 'This parameter is deprecated.', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the common alert configuration.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12300', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1EBF271', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 12300,\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1EBF271\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateConfigResponse>\\r\\n <RequestId>208B016D-4CB9-4A85-96A5-0B8ED1EBF271</RequestId>\\r\\n</CreateConfigResponse>","errorExample":""}]', + 'title' => 'CreateConfig', + 'description' => 'You can call this operation to create or restore configurations based on the codes of common configuration items. This allows you to manage the configurations of common configuration items.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeConfigs' => [ + 'summary' => 'Queries common configuration items for alerts.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddpCHNP1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'ConfigList' => [ + 'description' => 'An array that consists of common configuration items for alerts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the common configuration item.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '1', + ], + 'Value' => [ + 'description' => 'The value of the common configuration item.'."\n", + 'type' => 'string', + 'format' => 'int64', + 'example' => '30', + ], + 'DefaultValue' => [ + 'description' => 'The description of the default value for the common configuration item.'."\n", + 'type' => 'string', + 'example' => 'The volume of logs of a specific type that are generated on the current day is less than 30% of the average volume of logs generated in the previous 10 days.'."\n", + ], + 'Description' => [ + 'description' => 'The description of the common configuration item.'."\n", + 'type' => 'string', + 'example' => 'Anomalous log output'."\n", + ], + 'Id' => [ + 'description' => 'The unique ID of the common configuration item.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2133', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"ConfigList\\": [\\n {\\n \\"Code\\": 1,\\n \\"Value\\": 30,\\n \\"DefaultValue\\": \\"当日某类日志输出量低于前10天平均值的30%\\",\\n \\"Description\\": \\"日志未有效输出\\",\\n \\"Id\\": 2133\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeConfigs>\\n<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n<ConfigList>\\n <Code>2001</Code>\\n <DefaultValue>目前的阈值定义为10次</DefaultValue>\\n <Description>当日某类日志输出量低于前10天平均值的30%</Description>\\n <Id>2133</Id>\\n <Value>10</Value>\\n</ConfigList>\\n</DescribeConfigs>","errorExample":""}]', + 'title' => 'DescribeConfigs', + 'extraInfo' => ' ', + ], + 'ModifyReportTaskStatus' => [ + 'summary' => 'Enables or disables the report task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118114', + 'abilityTreeNodes' => [ + 'FEATUREsddp6DN9CR', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportTaskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the status of the report task. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n" + ."\n" + .'> This parameter is required.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1EBF271', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1EBF271\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyReportTaskStatusResponse>\\n <RequestId>208B016D-4CB9-4A85-96A5-0B8ED1EBF271</RequestId>\\n</ModifyReportTaskStatusResponse>","errorExample":""}]', + 'title' => 'ModifyReportTaskStatus', + 'description' => 'You can call this operation to enable or disable the report task. After you activate Data Security Center (DSC), the report task is enabled by default. After you disable the report task, you cannot view statistics that are newly generated in the Report Center module, on the Overview page of the Cloud Native Data Audit module, and in the Data security lab module. Existing statistics are not affected.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserStatus' => [ + 'summary' => 'Queries the information about an account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82092', + 'abilityTreeNodes' => [ + 'FEATUREsddp4GFW27', + 'FEATUREsddpKPIKAW', + 'FEATUREsddp7JHQOS', + 'FEATUREsddpXD0XSH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese (default)'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'UserStatus' => [ + 'description' => 'The information about the current account.'."\n", + 'type' => 'object', + 'properties' => [ + 'UseOssSize' => [ + 'description' => 'The occupied space of the Object Storage Service (OSS) bucket. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'UseInstanceNum' => [ + 'description' => 'The number of instances that are used.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '125', + ], + 'InstanceNum' => [ + 'description' => 'The number of instances within the current account.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'ChargeType' => [ + 'description' => 'The billing method of DCS that is purchased by using the current account. Valid values:'."\n" + ."\n" + .'* **PREPAY**: subscription'."\n" + .'* **POSTPAY**: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'Authed' => [ + 'description' => 'Indicates whether DSC has permission to access user resources within the current account. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LabStatus' => [ + 'description' => 'Indicates whether the data security lab feature is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RemainDays' => [ + 'description' => 'The remaining period for which the data assets within the current account can be protected by DSC.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '131', + ], + 'Trail' => [ + 'description' => 'Indicates whether the current account uses a free trial of DSC. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceId' => [ + 'description' => 'The ID of the data security center instance purchased by the main account.', + 'type' => 'string', + 'example' => 'sddp-cn-****', + ], + 'AccessKeyId' => [ + 'description' => 'The AccessKey ID of the current account.'."\n", + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'Purchased' => [ + 'description' => 'Indicates whether DSC is purchased. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DataManagerRole' => [ + 'description' => 'The permissions that the current account has. Valid values:'."\n" + ."\n" + .'* **0**: The current account has the administrative permissions or read-only permissions on Data Security Center.'."\n" + .'* **1**: The current account has the permissions to manage data domains.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'ReleaseDays' => [ + 'description' => 'The grace period between when DSC is expired and when DSC is released. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'AuditClosable' => [ + 'description' => 'Indicates whether the SQL Explorer feature can be disabled. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AuditReleasable' => [ + 'description' => 'Indicates whether the audit resources can be released.'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReleaseTime' => [ + 'description' => 'The time when the audit resources are released. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15000', + ], + 'InstanceTotalCount' => [ + 'description' => 'The total number of instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OssTotalSize' => [ + 'description' => 'OSS total storage capacity. Unit: Bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2048', + ], + 'UseAgentAudit' => [ + 'description' => 'Indicates whether the agent audit feature is used. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'boolean', + 'example' => '1', + ], + 'ProtectionDays' => [ + 'description' => 'Accumulate the number of days to protect user assets.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AssetRoleAuthed' => [ + 'type' => 'boolean', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"UserStatus\\": {\\n \\"UseOssSize\\": 234,\\n \\"UseInstanceNum\\": 125,\\n \\"InstanceNum\\": 32,\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"Authed\\": true,\\n \\"LabStatus\\": 1,\\n \\"RemainDays\\": 131,\\n \\"Trail\\": true,\\n \\"InstanceId\\": \\"sddp-cn-****\\",\\n \\"AccessKeyId\\": \\"yourAccessKeyID\\",\\n \\"Purchased\\": true,\\n \\"DataManagerRole\\": 1,\\n \\"ReleaseDays\\": 15,\\n \\"AuditClosable\\": true,\\n \\"AuditReleasable\\": true,\\n \\"ReleaseTime\\": 15000,\\n \\"InstanceTotalCount\\": 10,\\n \\"OssTotalSize\\": 2048,\\n \\"UseAgentAudit\\": true,\\n \\"ProtectionDays\\": 22,\\n \\"AssetRoleAuthed\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserStatusResponse>\\n <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n <UserStatus>\\n <UseOssSize>234</UseOssSize>\\n <UseInstanceNum>125</UseInstanceNum>\\n <InstanceNum>32</InstanceNum>\\n <ChargeType>PREPAY</ChargeType>\\n <Authed>true</Authed>\\n <LabStatus>1</LabStatus>\\n <RemainDays>131</RemainDays>\\n <Trail>true</Trail>\\n <InstanceId>ins-****</InstanceId>\\n <AccessKeyId>LTAI4G67HRBzNRmMhfyv****</AccessKeyId>\\n <Purchased>true</Purchased>\\n </UserStatus>\\n</DescribeUserStatusResponse>","errorExample":""}]', + 'title' => 'DescribeUserStatus', + 'description' => 'You can call this operation to query the information about the current account. This helps you get familiar with your account that accesses Data Security Center (DSC).'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableUserConfig' => [ + 'summary' => 'Disables a configuration item. After you disable a configuration item, you can call the CreateConfig operation to enable the configuration item by specifying the code of the configuration item for the Code parameter in the request.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82095', + 'abilityTreeNodes' => [ + 'FEATUREsddpR2D59W', + 'FEATUREsddpGH0F1O', + 'FEATUREsddpCHNP1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese (default)'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the configuration item. You can call the [DescribeConfigs](~~DescribeConfigs~~) operation to obtain the code of the configuration item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'access_failed_cnt', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AC314611-D907-5EBF-B6D8-70425E5A8643', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AC314611-D907-5EBF-B6D8-70425E5A8643\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableUserConfigResponse>\\r\\n<RequestId>AC314611-D907-5EBF-B6D8-70425E5A8643</RequestId>\\r\\n</DisableUserConfigResponse>","errorExample":""}]', + 'title' => 'DisableUserConfig', + 'description' => 'You can call this operation to disable a configuration item based on the code of the configuration item. This helps you modify configurations at the earliest opportunity.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyEventTypeStatus' => [ + 'summary' => 'Enables the detection of anomalous events of subtypes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82115', + 'abilityTreeNodes' => [ + 'FEATUREsddpR2D59W', + 'FEATUREsddpGH0F1O', + 'FEATUREsddpCHNP1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values: **zh** and **en**. The value zh indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SubTypeIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the anomalous event subtype. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'> You can call the **DescribeEventTypes** operation to query the ID of anomalous event subtype.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '020008', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1E*****', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1E*****\\"\\n}","type":"json"}]', + 'title' => 'ModifyEventTypeStatus', + ], + 'ModifyEventStatus' => [ + 'summary' => 'Handles an anomalous event.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddpGH0F1O', + 'FEATUREsddpR2D59W', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the anomalous event.'."\n" + ."\n" + .'> You can call the **DescribeEvents** operation to query the ID of the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Backed', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enhance the detection of anomalous events. If you enhance the detection of anomalous events, the detection accuracy and the rate of triggering alerts for anomalous events are improved. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DealReason', + 'in' => 'query', + 'schema' => [ + 'description' => 'The reason why the anomalous event is handled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Anomaly confirmed'."\n", + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method to handle the anomalous event. Valid values:'."\n" + ."\n" + .'* **1**: marks the anomalous event as a false positive.'."\n" + .'* **2**: confirms and handles the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8491DBFD-48C0-4E11-B6FC-6F38921244A9', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8491DBFD-48C0-4E11-B6FC-6F38921244A9\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyEventStatus>\\r\\n\\t<RequestId>8491DBFD-48C0-4E11-B6FC-6F38921244A9</RequestId>\\r\\n</ModifyEventStatus>\\t\\r\\n","errorExample":""}]', + 'title' => 'ModifyEventStatus', + 'description' => 'You can call this operation to handle anomalous events that involve data leaks. This helps protect your data assets at the earliest opportunity.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'extraInfo' => ' ', + ], + 'DescribeEvents' => [ + 'summary' => 'Queries anomalous events.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82036', + 'abilityTreeNodes' => [ + 'FEATUREsddpR2D59W', + 'FEATUREsddpGH0F1O', + 'FEATUREsddpCHNP1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '789026', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account that triggered the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1978132506596***', + ], + ], + [ + 'name' => 'DealUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account that handles the anomalous event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yundun-***', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The handling status of the anomalous event. Valid values:'."\n" + ."\n" + .'* 0: unhandled'."\n" + .'* 1: confirmed'."\n" + .'* 2: marked as false positive'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TypeCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the anomalous event type. Valid values:'."\n" + ."\n" + .'* 01: anomalous permission usage'."\n" + .'* 02: anomalous data flow'."\n" + .'* 03: anomalous data operation'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '02', + ], + ], + [ + 'name' => 'SubTypeCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the anomalous event subtype.'."\n" + ."\n" + .'> You can call the **DescribeEventTypes** operation to query the name of the anomalous event subtype.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Anomalous volume of downloaded data'."\n", + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range during which the anomalous events are detected. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1657900000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range during which the anomalous events are detected. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1698700000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the data asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-uf6yzvbc2tg90iuxk.l****', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service to which the table belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'TargetProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination service in an anomalous data flow. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the RAM user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'WarnLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The risk level of the alert that is triggered. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'An array that consists of the anomalous events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The anomalous event.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the account that triggered the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'yundunsr', + ], + 'Status' => [ + 'description' => 'The handling status for the anomalous event. Valid values:'."\n" + ."\n" + .'* 0: unhandled'."\n" + .'* 1: confirmed'."\n" + .'* 2: marked as false positive'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WarnLevel' => [ + 'description' => 'The severity of the anomalous event.'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UserId' => [ + 'description' => 'The ID of the account that triggered the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1978132506596***', + ], + 'StatusName' => [ + 'description' => 'The name of the handling status for the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'Pending'."\n", + ], + 'DealTime' => [ + 'description' => 'The time when the anomalous event was handled. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12223300', + ], + 'DealLoginName' => [ + 'description' => 'The username of the account that is used to handle the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'det1111', + ], + 'SubTypeName' => [ + 'description' => 'The name of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => 'Anomalous volume of downloaded data'."\n", + ], + 'Backed' => [ + 'description' => 'Indicates whether the detection of anomalous events is enhanced. If the detection of anomalous events is enhanced, the detection accuracy and the rate of triggering alerts for anomalous events are improved. Valid values:'."\n" + ."\n" + .'* true: yes'."\n" + .'* false: no'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'EventTime' => [ + 'description' => 'The time when the anomalous event occurred. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545829129000', + ], + 'LoginName' => [ + 'description' => 'The username of the account that triggered the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'det1111', + ], + 'SubTypeCode' => [ + 'description' => 'The code of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => '020008', + ], + 'TargetProductCode' => [ + 'description' => 'The name of the destination service in an anomalous data flow.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'TypeCode' => [ + 'description' => 'The code of the anomalous event type.'."\n", + 'type' => 'string', + 'example' => '02', + ], + 'AlertTime' => [ + 'description' => 'The time when an alert was triggered for the anomalous event. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '154529000', + ], + 'DealUserId' => [ + 'description' => 'The ID of the account that is used to handle the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '229157443385014***', + ], + 'TypeName' => [ + 'description' => 'The name of the anomalous event type.'."\n", + 'type' => 'string', + 'example' => 'Anomalous data flow'."\n", + ], + 'DealDisplayName' => [ + 'description' => 'The display name of the account that is used to handle the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'yundunsr', + ], + 'Id' => [ + 'description' => 'The ID of the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42233335555', + ], + 'ProductCode' => [ + 'description' => 'The name of the service in which the anomalous event was detected.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"PageSize\\": 12,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"DisplayName\\": \\"yundunsr\\",\\n \\"Status\\": 0,\\n \\"WarnLevel\\": 2,\\n \\"UserId\\": 0,\\n \\"StatusName\\": \\"待处理\\",\\n \\"DealTime\\": 12223300,\\n \\"DealLoginName\\": \\"det1111\\",\\n \\"SubTypeName\\": \\"数据下载量异常\\",\\n \\"Backed\\": false,\\n \\"EventTime\\": 1545829129000,\\n \\"LoginName\\": \\"det1111\\",\\n \\"SubTypeCode\\": \\"020008\\",\\n \\"TargetProductCode\\": \\"RDS\\",\\n \\"TypeCode\\": \\"02\\",\\n \\"AlertTime\\": 154529000,\\n \\"DealUserId\\": 0,\\n \\"TypeName\\": \\"数据流转异常\\",\\n \\"DealDisplayName\\": \\"yundunsr\\",\\n \\"Id\\": 42233335555,\\n \\"ProductCode\\": \\"RDS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeEvents>\\n<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n<PageSize>10</PageSize>\\n<CurrentPage>1</CurrentPage>\\n<TotalCount>1</TotalCount>\\n<Items>\\n <Status>0</Status>\\n <TypeName>数据流转异常</TypeName>\\n <Backed>false</Backed>\\n <TypeCode>02</TypeCode>\\n <ProductCode>RDS</ProductCode>\\n <SubTypeName>数据下载量异常</SubTypeName>\\n <EventTime>1545829129000</EventTime>\\n <UserId>229157443385014140</UserId>\\n <LoginName>det1111</LoginName>\\n <DisplayName>yundunsr</DisplayName>\\n <Id>54122244</Id>\\n <SubTypeCode>020008</SubTypeCode>\\n <AlertTime>1545829129000</AlertTime>\\n <StatusName>待处理</StatusName>\\n <DealUserId>229157443385014140</DealUserId>\\n <DealLoginName>det1111</DealLoginName>\\n <DeaulDisplayName>yundunsr</DeaulDisplayName>\\n <DepartName>test</DepartName>\\n</Items>\\n</DescribeEvents>","errorExample":""}]', + 'title' => 'DescribeEvents', + 'description' => 'You can call this operation to query anomalous events that may involve data leaks. This helps you search for and handle anomalous events.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEventDetail' => [ + 'summary' => 'Queries the details of an anomalous event. The details include the time when the anomalous event occurred, and the description and handling status of the anomalous event.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82033', + 'abilityTreeNodes' => [ + 'FEATUREsddpR2D59W', + 'FEATUREsddpGH0F1O', + 'FEATUREsddpCHNP1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the anomalous event.'."\n" + ."\n" + .'> You can call the **DescribeEvents** operation to query the ID of the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '13456723343', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'Event' => [ + 'description' => 'The details of the anomalous event.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => 'The display name of the account that triggered the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'yundunsr', + ], + 'Status' => [ + 'description' => 'The handling status for the anomalous event. Valid values:'."\n" + ."\n" + .'* **0**: unhandled'."\n" + .'* **1**: confirmed'."\n" + .'* **2**: marked as false positive'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DealReason' => [ + 'description' => 'The reason why the anomalous event is handled.'."\n", + 'type' => 'string', + 'example' => 'Anomaly confirmed'."\n", + ], + 'UserId' => [ + 'description' => 'The ID of the account that triggered the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '229157443385014***', + ], + 'StatusName' => [ + 'description' => 'The name of the handling status for the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'Pending'."\n", + ], + 'DealTime' => [ + 'description' => 'The time when the anomalous event was handled. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1230000', + ], + 'DealLoginName' => [ + 'description' => 'The username of the account that is used to handle the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'det1111', + ], + 'SubTypeName' => [ + 'description' => 'The name of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => 'Anomalous volume of downloaded data'."\n", + ], + 'Backed' => [ + 'description' => 'Indicates whether the handling result of the anomalous event is used to enhance the detection of anomalous events. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n" + ."\n" + .'> If you enhance the detection of anomalous events, the detection accuracy and the rate of triggering alerts for anomalous events are improved.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataInstance' => [ + 'description' => 'The instance name of the service in which the anomalous event was detected.'."\n", + 'type' => 'string', + 'example' => 'in-222***', + ], + 'EventTime' => [ + 'description' => 'The time when the anomalous event occurred. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545829129000', + ], + 'LoginName' => [ + 'description' => 'The username of the account that triggered the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'det1111', + ], + 'SubTypeCode' => [ + 'description' => 'The code of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => '020008', + ], + 'LogDetail' => [ + 'description' => 'The details of the alert logs.'."\n", + 'type' => 'string', + 'example' => '{"client_ip": ["106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX", "106.11.XX.XX"], "start_time": "2020-05-10 00:00:01", "instance": ["omniscience-data", "punish-beaver-data"], "end_time": "2020-05-10 00:21:22", "client_ua": ["Java/1.8.0_152", "Java/1.8.0_92", "aliyun-sdk-java/2.0.0", "aliyun-sdk-java/2.8.0(Linux/4.9.151-015.ali3000.alios7.x86_64/amd64;1.8.0_152)"], "user_name": 1512222261295262}', + ], + 'TypeCode' => [ + 'description' => 'The code of the anomalous event type.'."\n", + 'type' => 'string', + 'example' => '02', + ], + 'AlertTime' => [ + 'description' => 'The time when the alert for the anomalous event was generated. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545829129000', + ], + 'DealUserId' => [ + 'description' => 'The ID of the account that is used to handle the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '229157443385014***', + ], + 'TypeName' => [ + 'description' => 'The name of the anomalous event type. Valid values:'."\n" + ."\n" + .'* **01**: anomalous permission usage'."\n" + .'* **02**: anomalous data flow'."\n" + .'* **03**: anomalous data operation'."\n", + 'type' => 'string', + 'example' => 'Anomalous data flow'."\n", + ], + 'DealDisplayName' => [ + 'description' => 'The display name of the account that is used to handle the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'yundunsr', + ], + 'Id' => [ + 'description' => 'The unique ID of the anomalous event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52234', + ], + 'ProductCode' => [ + 'description' => 'The name of the service in which the anomalous event was detected. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'HandleInfoList' => [ + 'description' => 'An array that consists of the handling records of the anomalous event.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a record in which the anomalous event is manually handled.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the account that triggered the anomalous event. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n" + .'* **-1**: failed to disable the account'."\n" + .'* **-2**: failed to enable the account'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableTime' => [ + 'description' => 'The time when the disabled account is enabled. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611139155000', + ], + 'HandlerValue' => [ + 'description' => 'The duration for which the handling operation takes effect. If you leave this parameter empty, the handling operation is permanently valid. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DisableTime' => [ + 'description' => 'The time when the account is disabled. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611139155000', + ], + 'HandlerName' => [ + 'description' => 'The handling method.'."\n", + 'type' => 'string', + 'example' => 'Remove from the whitelist'."\n", + ], + 'HandlerType' => [ + 'description' => 'The type of the handling method.'."\n", + 'type' => 'string', + 'example' => 'rds_security_ip', + ], + 'CurrentValue' => [ + 'description' => 'The account that is used to handle the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'sddp-test2', + ], + 'Id' => [ + 'description' => 'The ID of the handling rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + ], + ], + ], + 'Detail' => [ + 'description' => 'The content in the details of the anomalous event.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content in the anomalous event.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'An array that consists of the content in the anomalous event.'."\n", + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'The title of the content in the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'Anomaly description'."\n", + ], + 'Value' => [ + 'description' => 'The description of the content in the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'The account was used to access OSS from an unusual terminal whose IP address is 1.2.3.4 from 00:06:45 on September 9, 2019 to 00:57:37 on September 9, 2019.'."\n", + ], + 'Name' => [ + 'description' => 'Exception event name.', + 'type' => 'string', + 'example' => 'daliaoyuncom', + ], + ], + ], + ], + 'Chart' => [ + 'description' => 'The baseline behavior chart of the anomalous event.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The baseline behavior chart of the anomalous event.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the chart. Valid values:'."\n" + ."\n" + .'* **1**: column chart'."\n" + .'* **2**: line chart'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Label' => [ + 'description' => 'The name of the baseline behavior chart of the anomalous event.'."\n", + 'type' => 'string', + 'example' => 'Baseline behavior chart'."\n", + ], + 'XLabel' => [ + 'description' => 'The descriptive label of data items on the X axis.'."\n", + 'type' => 'string', + 'example' => 'Number of days'."\n", + ], + 'YLabel' => [ + 'description' => 'The descriptive label of data items on the Y axis.'."\n", + 'type' => 'string', + 'example' => 'Value'."\n", + ], + 'Data' => [ + 'description' => 'The data in the baseline behavior profile of the anomalous event.'."\n", + 'type' => 'object', + 'properties' => [ + 'Y' => [ + 'description' => 'The value of the data item on the Y axis.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the data item on the Y axis.'."\n", + 'type' => 'string', + 'example' => '[1,2,3,...]', + ], + 'example' => '[1,2,3,...]', + ], + 'X' => [ + 'description' => 'The value of the data item on the X axis.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the data item on the X axis.'."\n", + 'type' => 'string', + 'example' => '[test1,test2,...]', + ], + 'example' => '[test1,test2,...]', + ], + 'Z' => [ + 'description' => 'The value of the data item for the Z axis.', + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the data item for the Z axis.', + 'type' => 'string', + 'example' => '[5,7,...]'."\n", + ], + ], + ], + ], + 'ChatType' => [ + 'description' => 'The type of the chart. Valid values:'."\n" + ."\n" + .'* **1**: column chart'."\n" + .'* **2**: line chart'."\n" + ."\n" + .'>This field will be returned only when NewAlarm is true.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'Icon title.'."\n" + ."\n" + .'>This field will be returned only when NewAlarm is true.', + 'type' => 'string', + 'example' => 'misskingm', + ], + 'ZLabel' => [ + 'description' => 'The descriptive label of data items on the Z axis.'."\n" + ."\n" + .'>This field will be returned only when NewAlarm is true.', + 'type' => 'string', + 'example' => 'chart description'."\n", + ], + ], + ], + ], + 'ResourceInfo' => [ + 'description' => 'An array that consists of the source from which the information of the anomalous event is recorded.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The source.'."\n", + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'The source title.'."\n", + 'type' => 'string', + 'example' => 'Risk'."\n", + ], + 'Value' => [ + 'description' => 'The source description.'."\n", + 'type' => 'string', + 'example' => 'Based on the record of authentication by using an unusual terminal, an attacker may have obtained the access permission of the account, or an employee accessed data from a personal terminal.'."\n", + ], + ], + ], + ], + ], + ], + 'NewAlarm' => [ + 'description' => 'Whether it is a new version of the alarm. Value:'."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"Event\\": {\\n \\"DisplayName\\": \\"yundunsr\\",\\n \\"Status\\": 0,\\n \\"DealReason\\": \\"Anomaly confirmed\\\\n\\",\\n \\"UserId\\": 0,\\n \\"StatusName\\": \\"Pending\\",\\n \\"DealTime\\": 1611139155000,\\n \\"DealLoginName\\": \\"det1111\\",\\n \\"SubTypeName\\": \\"Anomalous volume of downloaded data\\\\n\\",\\n \\"Backed\\": false,\\n \\"DataInstance\\": \\"in-222***\\",\\n \\"EventTime\\": 1545829129000,\\n \\"LoginName\\": \\"det1111\\",\\n \\"SubTypeCode\\": \\"020008\\",\\n \\"LogDetail\\": \\"{\\\\\\"client_ip\\\\\\": [\\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\", \\\\\\"106.11.XX.XX\\\\\\"], \\\\\\"start_time\\\\\\": \\\\\\"2020-05-10 00:00:01\\\\\\", \\\\\\"instance\\\\\\": [\\\\\\"omniscience-data\\\\\\", \\\\\\"punish-beaver-data\\\\\\"], \\\\\\"end_time\\\\\\": \\\\\\"2020-05-10 00:21:22\\\\\\", \\\\\\"client_ua\\\\\\": [\\\\\\"Java/1.8.0_152\\\\\\", \\\\\\"Java/1.8.0_92\\\\\\", \\\\\\"aliyun-sdk-java/2.0.0\\\\\\", \\\\\\"aliyun-sdk-java/2.8.0(Linux/4.9.151-015.ali3000.alios7.x86_64/amd64;1.8.0_152)\\\\\\"], \\\\\\"user_name\\\\\\": 1512222261295262}\\",\\n \\"TypeCode\\": \\"02\\",\\n \\"AlertTime\\": 1545829129000,\\n \\"DealUserId\\": 0,\\n \\"TypeName\\": \\"Anomalous data flow\\\\n\\",\\n \\"DealDisplayName\\": \\"yundunsr\\",\\n \\"Id\\": 52234,\\n \\"ProductCode\\": \\"MaxCompute\\",\\n \\"HandleInfoList\\": [\\n {\\n \\"Status\\": 1,\\n \\"EnableTime\\": 1611139155000,\\n \\"HandlerValue\\": 10,\\n \\"DisableTime\\": 1611139155000,\\n \\"HandlerName\\": \\"Remove from the whitelist\\\\n\\",\\n \\"HandlerType\\": \\"rds_security_ip\\",\\n \\"CurrentValue\\": \\"sddp-test2\\",\\n \\"Id\\": 11\\n }\\n ],\\n \\"Detail\\": {\\n \\"Content\\": [\\n {\\n \\"Label\\": \\"Anomaly description\\\\n\\",\\n \\"Value\\": \\"The account was used to access OSS from an unusual terminal whose IP address is 1.2.3.4 from 00:06:45 on September 9, 2019 to 00:57:37 on September 9, 2019.\\",\\n \\"Name\\": \\"daliaoyuncom\\"\\n }\\n ],\\n \\"Chart\\": [\\n {\\n \\"Type\\": \\"1\\",\\n \\"Label\\": \\"Baseline behavior chart\\\\n\\",\\n \\"XLabel\\": \\"Number of days\\\\n\\",\\n \\"YLabel\\": \\"Value\\",\\n \\"Data\\": {\\n \\"Y\\": [\\n \\"[1,2,3,...]\\"\\n ],\\n \\"X\\": [\\n \\"[test1,test2,...]\\"\\n ],\\n \\"Z\\": [\\n \\"[5,7,...]\\"\\n ]\\n },\\n \\"ChatType\\": 1,\\n \\"Name\\": \\"misskingm\\",\\n \\"ZLabel\\": \\"chart description\\"\\n }\\n ],\\n \\"ResourceInfo\\": [\\n {\\n \\"Label\\": \\"Risk\\",\\n \\"Value\\": \\"Based on the record of authentication by using an unusual terminal, an attacker may have obtained the access permission of the account, or an employee accessed data from a personal terminal.\\"\\n }\\n ]\\n },\\n \\"NewAlarm\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventDetailResponse>\\n <RequestId>69FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n <Event>\\n <DisplayName>yundunsr</DisplayName>\\n <Status>0</Status>\\n <DealReason>确定为违例</DealReason>\\n <UserId>229157443385014140</UserId>\\n <StatusName>待处理</StatusName>\\n <DealTime>1230000</DealTime>\\n <DealLoginName>det1111</DealLoginName>\\n <SubTypeName>数据下载量异常</SubTypeName>\\n <Backed>false</Backed>\\n <DataInstance>in-222***</DataInstance>\\n <EventTime>1545829129000</EventTime>\\n <LoginName>det1111</LoginName>\\n <SubTypeCode>020008</SubTypeCode>\\n <LogDetail>{\\"client_ip\\": [\\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\", \\"106.11.XX.XX\\"], \\"start_time\\": \\"2020-05-10 00:00:01\\", \\"instance\\": [\\"omniscience-data\\", \\"punish-beaver-data\\"], \\"end_time\\": \\"2020-05-10 00:21:22\\", \\"client_ua\\": [\\"Java/1.8.0_152\\", \\"Java/1.8.0_92\\", \\"aliyun-sdk-java/2.0.0\\", \\"aliyun-sdk-java/2.8.0(Linux/4.9.151-015.ali3000.alios7.x86_64/amd64;1.8.0_152)\\"], \\"user_name\\": 1512222261295262}</LogDetail>\\n <TypeCode>02</TypeCode>\\n <AlertTime>1545829129000</AlertTime>\\n <DealUserId>229157443385014140</DealUserId>\\n <TypeName>数据流转异常</TypeName>\\n <DealDisplayName>yundunsr</DealDisplayName>\\n <Id>52234</Id>\\n <ProductCode>MaxCompute</ProductCode>\\n <HandleInfoList>\\n <Status>1</Status>\\n <EnableTime>1611139155000</EnableTime>\\n <HandlerValue>10</HandlerValue>\\n <DisableTime>1611139155000</DisableTime>\\n <HandlerName>移除白名单</HandlerName>\\n <HandlerType>rds_security_ip</HandlerType>\\n <CurrentValue>sddp-test2</CurrentValue>\\n <Id>11</Id>\\n </HandleInfoList>\\n <Detail>\\n <Content>\\n <Label>异常描述</Label>\\n <Value>该账号在2019-09-09 00:06:45 至 2019-09-09 00:57:37之间使用异常终端(1.2.3.4)访问产品 OSS。</Value>\\n </Content>\\n <Chart>\\n <Type>1</Type>\\n <Label>基线行为画像</Label>\\n <XLabel>天数</XLabel>\\n <YLabel>值</YLabel>\\n <Data>\\n <Y>[1,2,3,...]</Y>\\n <X>[test1,test2,...]</X>\\n </Data>\\n </Chart>\\n <ResourceInfo>\\n <Label>事件风险</Label>\\n <Value>来自异常终端鉴权记录可能是由于账号访问权限被外部攻击者获取或者员工在使用非办公终端访问数据</Value>\\n </ResourceInfo>\\n </Detail>\\n </Event>\\n</DescribeEventDetailResponse>","errorExample":""}]', + 'title' => 'DescribeEventDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEventTypes' => [ + 'summary' => 'Queries the types of anomalous events.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82039', + 'abilityTreeNodes' => [ + 'FEATUREsddpR2D59W', + 'FEATUREsddpGH0F1O', + 'FEATUREsddpCHNP1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ParentTypeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of anomalous event for which you want to query the anomalous events of subtypes. Valid values:'."\n" + ."\n" + .'* **01**: anomalous permission usage'."\n" + .'* **02**: anomalous data flow'."\n" + .'* **03**: anomalous data operation'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the anomalous event. Valid values:'."\n" + ."\n" + .'* **1**: enabled'."\n" + .'* **2**: disabled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.'."\n", + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + 'EventTypeList' => [ + 'description' => 'An array that consists of the types of anomalous events.'."\n" + ."\n" + .'> If you leave the ParentTypeId parameter empty, anomalous event types are returned. If you set the ParentTypeId parameter, anomalous event subtypes under the specified anomalous event type are returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'An array that consists of anomalous event types.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the anomalous event type.'."\n", + 'type' => 'string', + 'example' => '01', + ], + 'Description' => [ + 'description' => 'The description of the anomalous event type.'."\n", + 'type' => 'string', + 'example' => 'Anomalous permission usage,\\*\\*\\*\\*'."\n", + ], + 'Name' => [ + 'description' => 'The name of the anomalous event type.'."\n", + 'type' => 'string', + 'example' => 'Anomalous permission usage'."\n", + ], + 'Id' => [ + 'description' => 'The ID of the anomalous event type.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SubTypeList' => [ + 'description' => 'An array that consists of anomalous event subtypes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the anomalous event subtype.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates whether detection is enabled for the anomalous event subtype. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Description' => [ + 'description' => 'The description of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => 'Inappropriate configuration-No protection for the MaxCompute sensitive project, \\*\\*\\*\\*'."\n", + ], + 'ConfigContentType' => [ + 'description' => 'The content format of anomalous event detection rule. Valid values:'."\n" + ."\n" + .'* **0**: numeric values such as thresholds'."\n" + .'* **1**: text such as IP addresses'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EventHitCount' => [ + 'description' => 'The number of times that the anomalous event hits the anomalous event detection rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfigValue' => [ + 'description' => 'The value of the configuration.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'ConfigCode' => [ + 'description' => 'The code of the configuration.'."\n", + 'type' => 'string', + 'example' => '0100**', + ], + 'Code' => [ + 'description' => 'The code of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => '020008', + ], + 'ConfigDescription' => [ + 'description' => 'The description of the configuration.'."\n", + 'type' => 'string', + 'example' => 'The period of time for which the permission is not used exceeds the threshold. The specified threshold is ${value} calendar days.'."\n", + ], + 'Name' => [ + 'description' => 'The name of the anomalous event subtype.'."\n", + 'type' => 'string', + 'example' => 'Inappropriate configuration-No protection for the MaxCompute sensitive project'."\n", + ], + 'AdaptedProduct' => [ + 'description' => 'The service to which the anomalous event detection rule applies. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'Id' => [ + 'description' => 'The ID of the anomalous event subtype.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\",\\n \\"EventTypeList\\": [\\n {\\n \\"Code\\": \\"01\\",\\n \\"Description\\": \\"权限使用异常，****\\",\\n \\"Name\\": \\"权限使用异常\\",\\n \\"Id\\": 1,\\n \\"SubTypeList\\": [\\n {\\n \\"Status\\": 1,\\n \\"Description\\": \\"配置失当-ODPS敏感项目未设置保护，****\\",\\n \\"ConfigContentType\\": 1,\\n \\"EventHitCount\\": 2,\\n \\"ConfigValue\\": \\"90\\",\\n \\"ConfigCode\\": \\"0100**\\",\\n \\"Code\\": \\"020008\\",\\n \\"ConfigDescription\\": \\"权限闲置期间超过阈值：目前的阈值定义为${value}个自然日\\",\\n \\"Name\\": \\"配置失当-ODPS敏感项目未设置保护\\",\\n \\"AdaptedProduct\\": \\"RDS\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventTypesResponse>\\n <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\n <EventTypeList>\\n <Code>01</Code>\\n <Description>权限使用异常，***</Description>\\n <Name>权限使用异常</Name>\\n <Id>1</Id>\\n <SubTypeList>\\n <Status>1</Status>\\n <Description>配置失当-ODPS敏感项目未设置保护，****</Description>\\n <ConfigContentType>1</ConfigContentType>\\n <EventHitCount>2</EventHitCount>\\n <ConfigValue>90</ConfigValue>\\n <ConfigCode>0100**</ConfigCode>\\n <Code>020008</Code>\\n <ConfigDescription>权限闲置期间超过阈值：目前的阈值定义为${value}个自然日</ConfigDescription>\\n <Name>配置失当-ODPS敏感项目未设置保护</Name>\\n <AdaptedProduct>RDS</AdaptedProduct>\\n <Id>1</Id>\\n </SubTypeList>\\n </EventTypeList>\\n</DescribeEventTypesResponse>","errorExample":""}]', + 'title' => 'DescribeEventTypes', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDataMaskingTasks' => [ + 'summary' => 'Queries de-identification tasks.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '82022', + 'abilityTreeNodes' => [ + 'FEATUREsddpNV5XKZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword used to query the de-identification tasks, which can be the task name or ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range during which the de-identification tasks to be queried are created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1582992000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range during which the de-identification tasks to be queried are created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1583856000000', + ], + ], + [ + 'name' => 'DstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service to which the data to be de-identified belongs. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-4******', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => 'A list of de-identification tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the de-identification task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Owner' => [ + 'description' => 'The user who created the de-identification task.'."\n", + 'type' => 'string', + 'example' => 'owner', + ], + 'TaskName' => [ + 'description' => 'The name of the task.'."\n", + 'type' => 'string', + 'example' => 'Task name'."\n", + ], + 'SrcType' => [ + 'description' => 'The type of the service to which the data to be de-identified belongs. Valid values: **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'DstType' => [ + 'description' => 'The service to which the data to be de-identified belongs. Valid values: **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'HasUnfinishProcess' => [ + 'description' => 'Indicates whether the de-identification task is running.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'OriginalTable' => [ + 'description' => 'Indicates whether the source table is de-identified.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'TriggerType' => [ + 'description' => 'The mode in which the de-identification task is run. Valid values:'."\n" + ."\n" + .'* **1**: manual'."\n" + .'* **2**: scheduled'."\n" + .'* **3**: manual and scheduled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DstTypeCode' => [ + 'description' => 'The type of the service to which the de-identified data belongs. Valid values: **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'RunCount' => [ + 'description' => 'The number of times that the de-identification task is run.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => 'The time when the de-identification task is created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582992000000', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => 'mt4HBgtw1B******', + ], + 'DstPath' => [ + 'description' => 'The destination path.'."\n", + 'type' => 'string', + 'example' => '***/table1', + ], + 'SrcTypeCode' => [ + 'description' => 'The type of the service to which the data to be de-identified belongs. Valid values: **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'Id' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SrcPath' => [ + 'description' => 'The source path.'."\n", + 'type' => 'string', + 'example' => '***/table2', + ], + 'SrcMemberAccount' => [ + 'description' => 'The member account to which the desensitization source belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '192479427903xxxx', + ], + 'DstMemberAccount' => [ + 'description' => 'The member account to which the desensitization target belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '192479427903xxxx', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-4******\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"Status\\": 1,\\n \\"Owner\\": \\"owner\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"SrcType\\": 5,\\n \\"DstType\\": 5,\\n \\"HasUnfinishProcess\\": false,\\n \\"OriginalTable\\": false,\\n \\"TriggerType\\": 1,\\n \\"DstTypeCode\\": \\"RDS\\",\\n \\"RunCount\\": 1,\\n \\"GmtCreate\\": 1582992000000,\\n \\"TaskId\\": \\"mt4HBgtw1B******\\",\\n \\"DstPath\\": \\"***/table1\\",\\n \\"SrcTypeCode\\": \\"RDS\\",\\n \\"Id\\": 1,\\n \\"SrcPath\\": \\"***/table2\\",\\n \\"SrcMemberAccount\\": 0,\\n \\"DstMemberAccount\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataMaskingTasksResponse>\\n<TotalCount>1</TotalCount>\\n<PageSize>5</PageSize>\\n<CurrentPage>1</CurrentPage>\\n<Items>\\n <Status>1</Status>\\n <TriggerType>1</TriggerType>\\n <Owner>***</Owner>\\n <TaskId>mt4HBgtw1B****</TaskId>\\n <DstPath>********</DstPath>\\n <HasUnfinishProcess>false</HasUnfinishProcess>\\n <DstTypeCode>OSS</DstTypeCode>\\n <SrcPath>*********</SrcPath>\\n <DstType>2</DstType>\\n <GmtCreate>1583739870000</GmtCreate>\\n <TaskName>任务名称</TaskName>\\n <SrcType>2</SrcType>\\n <RunCount>3</RunCount>\\n <Id>1</Id>\\n <SrcTypeCode>OSS</SrcTypeCode>\\n</Items>\\n</DescribeDataMaskingTasksResponse>","errorExample":""}]', + 'title' => 'DescribeDataMaskingTasks', + 'description' => 'You can call this operation to query static de-identification tasks. This facilitates task queries and management.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDataMaskingRunHistory' => [ + 'summary' => 'Queries the execution information about a de-identification task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddpNV5XKZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the de-identification task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mt4HBgtw1B******', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1582992000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1583856000000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the de-identification task. Valid values:'."\n" + ."\n" + .'* **-1**: waiting'."\n" + .'* **0**: being executed'."\n" + .'* **1**: executed'."\n" + .'* **2**: failed to be executed'."\n" + .'* **3**: terminated'."\n" + .'* **4**: partially failed'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SrcType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service to which the data to be de-identified belongs. Valid values: **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service to which the de-identified data belongs. Valid values: **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MainProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task.'."\n" + ."\n" + .'> If a task has one or more subtasks, the value of the parameter must be the ID of the task. Otherwise, leave this parameter empty.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '366731', + ], + ], + [ + 'name' => 'SrcTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'add', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-4******', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => 'The execution information about the de-identification task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the de-identification task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the de-identification task. Valid values:'."\n" + ."\n" + .'* **-1**: waiting'."\n" + .'* **0**: being executed'."\n" + .'* **1**: executed'."\n" + .'* **2**: failed to be executed'."\n" + .'* **3**: terminated'."\n" + .'* **4**: partially failed'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => 'The mode in which the de-identification task is executed. Valid values:'."\n" + ."\n" + .'* **1**: manual'."\n" + .'* **2**: scheduled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SrcType' => [ + 'description' => 'The type of the service to which the data to be de-identified belongs. Valid values: **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SrcTableName' => [ + 'description' => 'The name of the source table.'."\n", + 'type' => 'string', + 'example' => 'add', + ], + 'MaskingCount' => [ + 'description' => 'The number of rows that are de-identified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Percentage' => [ + 'description' => 'The progress of the de-identification task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DstType' => [ + 'description' => 'The type of the service to which the de-identified data belongs. Valid values: **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FailMsg' => [ + 'description' => 'The reason why the de-identification task fails.'."\n", + 'type' => 'string', + 'example' => 'error', + ], + 'FailCode' => [ + 'description' => 'The error code that is returned when the de-identification task fails.'."\n", + 'type' => 'string', + 'example' => 'masking_task_not_found', + ], + 'ConflictCount' => [ + 'description' => 'The number of rows that are in conflict with the data to be de-identified in the destination table to which the data to be de-identified is moved.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DstTypeCode' => [ + 'description' => 'The service that stores the de-identified data. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'EndTime' => [ + 'description' => 'The end time of the de-identification task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582251233000', + ], + 'RunIndex' => [ + 'description' => 'The number of times that the de-identification task is executed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => 'The time when the de-identification task was executed. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582251233000', + ], + 'HasSubProcess' => [ + 'description' => 'The number of created subtasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'HasDownloadFile' => [ + 'description' => 'Indicates whether a file is available for download.'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskId' => [ + 'description' => 'The ID of the identification task.'."\n", + 'type' => 'string', + 'example' => 'mt4HBgtw1B******', + ], + 'SrcTypeCode' => [ + 'description' => 'The service to which the data to be de-identified belongs. Valid values include **MaxCompute, OSS, ADS, OTS, and RDS**.'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Id' => [ + 'description' => 'The ID of the task execution record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"769FB3C1-F4C9-4******\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"Status\\": 1,\\n \\"Type\\": 1,\\n \\"SrcType\\": 2,\\n \\"SrcTableName\\": \\"add\\",\\n \\"MaskingCount\\": 100,\\n \\"Percentage\\": 100,\\n \\"DstType\\": 2,\\n \\"FailMsg\\": \\"error\\",\\n \\"FailCode\\": \\"masking_task_not_found\\",\\n \\"ConflictCount\\": 0,\\n \\"DstTypeCode\\": \\"OSS\\",\\n \\"EndTime\\": 1582251233000,\\n \\"RunIndex\\": 1,\\n \\"StartTime\\": 1582251233000,\\n \\"HasSubProcess\\": 4,\\n \\"HasDownloadFile\\": 1,\\n \\"TaskId\\": \\"mt4HBgtw1B******\\",\\n \\"SrcTypeCode\\": \\"OSS\\",\\n \\"Id\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDataMaskingRunHistory>\\n<TotalCount>1</TotalCount>\\n<PageSize>5</PageSize>\\n<CurrentPage>1</CurrentPage>\\n<Items>\\n <Status>1</Status>\\n <RunIndex>1</RunIndex>\\n <TaskId>Vd8Rj80eBXR*****</TaskId>\\n <Percentage>100</Percentage>\\n <MaskingCount>100000</MaskingCount>\\n <StartTime>1582251233000</StartTime>\\n <DstTypeCode>RDS</DstTypeCode>\\n <ConflictCount>0</ConflictCount>\\n <DstType>5</DstType>\\n <Type>1</Type>\\n <SrcType>1</SrcType>\\n <Id>4869</Id>\\n <SrcTypeCode>MaxCompute</SrcTypeCode>\\n</Items>\\n<RequestId>769FB3C1-F4C9-4******</RequestId>\\n</DescribeDataMaskingRunHistory>","errorExample":""}]', + 'title' => 'DescribeDataMaskingRunHistory', + 'description' => 'You can call this operation to query the execution information of a static de-identification task, including the status and progress.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'extraInfo' => ' ', + ], + 'ExecDatamask' => [ + 'summary' => 'Dynamically de-identifies sensitive data.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82098', + 'abilityTreeNodes' => [ + 'FEATUREsddpUBRQH2', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the de-identification template. The ID is generated after you create the de-identification template in the [Data Security Center (DSC) console](https://yundun.console.aliyun.com/?\\&p=sddpnext#/sddp/dm/template). You can choose **Data desensitization** > **Desensitization Template** in the left-side navigation pane and obtain the ID of the de-identification template from the **Desensitization Template** page.'."\n" + ."\n" + .'* If you select **Field name** as the matching mode of the template, DSC matches data based on the columns specified by the **dataHeaderList** parameter in the **Data** parameter.'."\n" + .'* If you select **Sensitive type** as the matching mode of the template, DSC matches data based on the sensitive data detection rules specified by the **ruleList** parameter in the **Data** parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sensitive data to be de-identified. The value is a JSON string that contains the following parameters:'."\n" + ."\n" + .'* **dataHeaderList**: the names of the columns in which data needs to be de-identified. Specify the column names in accordance with the order of data that needs to be de-identified.'."\n" + .'* **dataList**: the data that needs to be de-identified.'."\n" + .'* **ruleList**: the IDs of sensitive data detection rules used to detect data that needs to be de-identified. Specify the rule IDs in accordance with the order of data that needs to be de-identified. Each ID identifies a sensitive data detection rule that is used to detect a type of sensitive data. You can call the [DescribeRules](~~DescribeRules~~) operation to query the IDs of sensitive data detection rules.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"dataHeaderList":["name","age"],"dataList":[["lily",18],["lucy",17]],"ruleList":[1002,null]}', + ], + ], + [ + 'name' => 'FeatureType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'This parameter is deprecated.', + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh_cn**. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The de-identified data, which is described in a JSON string. The JSON string contains the following parameters:'."\n" + ."\n" + .'* **dataHeaderList**: the names of columns that contain the de-identified data.'."\n" + .'* **dataList**: the de-identified data. The column order of the de-identified data is the same as that indicated by the dataHeaderList parameter.'."\n" + .'* **ruleList**: the IDs of sensitive data detection rules.'."\n", + 'type' => 'string', + 'example' => '{"dataHeaderList":["name","age"],"dataList":[["l***",18],["l***",17]],"ruleList":[1002,null]}', + ], + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '813BA9FA-D062-42C4-8CD5-11A7640B96E6', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\"dataHeaderList\\\\\\":[\\\\\\"name\\\\\\",\\\\\\"age\\\\\\"],\\\\\\"dataList\\\\\\":[[\\\\\\"l***\\\\\\",18],[\\\\\\"l***\\\\\\",17]],\\\\\\"ruleList\\\\\\":[1002,null]}\\",\\n \\"RequestId\\": \\"813BA9FA-D062-42C4-8CD5-11A7640B96E6\\"\\n}","errorExample":""},{"type":"xml","example":"<ExecDatamaskResponse>\\n <Data>{\\"dataHeaderList\\":[\\"name\\",\\"age\\"],\\"dataList\\":[[\\"l***\\",18],[\\"l***\\",17]],\\"ruleList\\":[1002,null]}</Data>\\n <RequestId>813BA9FA-D062-42C4-8CD5-11A7640B96E6</RequestId>\\n</ExecDatamaskResponse>","errorExample":""}]', + 'title' => 'ExecDatamask', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopMaskingProcess' => [ + 'summary' => 'Stops a de-identification task. After you stop a de-identification task, you can resume the task by calling the ManualTriggerMaskingProcess operation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82133', + 'abilityTreeNodes' => [ + 'FEATUREsddpNV5XKZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese (default)'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the de-identification task. You can query the task ID by calling the [DescribeDataMaskingTasks](~~DescribeDataMaskingTasks~~) operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-42DF-9B72-7077A8989C13', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"769FB3C1-F4C9-42DF-9B72-7077A8989C13\\"\\n}","errorExample":""},{"type":"xml","example":"<StopMaskingProcessResponse>\\r\\n<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>\\r\\n</StopMaskingProcessResponse>","errorExample":""}]', + 'title' => 'StopMaskingProcess', + 'description' => 'You can call this operation to stop a de-identification task that is running. For example, you can stop a de-identification task that is used to de-identify specific data.'."\n" + ."\n" + .'# Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'extraInfo' => ' ', + ], + 'ManualTriggerMaskingProcess' => [ + 'summary' => 'Triggers a de-identification task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '82102', + 'abilityTreeNodes' => [ + 'FEATUREsddpNV5XKZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response, default value zh_cn. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Chinese'."\n" + .'* **en_us**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the de-identification task.'."\n" + ."\n" + .'The ID of the de-identification task is a string. You can call the DescribeDataMaskingTasks operation to query the ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '769FB3C1-F4C9-4******', + ], + ], + 'description' => 'Return result object.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C3AC882-E5A8-4855-BE77-B6837B695EF1\\"\\n}","type":"json"}]', + 'title' => 'ManualTriggerMaskingProcess', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeIdentifyTaskStatus' => [ + 'summary' => 'Query the status of an identification task', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240902', + 'abilityTreeNodes' => [ + 'FEATUREsddpXMFUF8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task ID, obtained from the ID field in the response after calling CreateScanTask or ScanOssObjectV1.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '268', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Language type for request and response messages, default is **zh_cn**. Values:'."\n" + .'- **zh_cn**: Chinese (Simplified)'."\n" + .'- **en_us**: English (United States)', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', + 'type' => 'string', + 'example' => '71064826-726F-4ADA-B879-05D8055476FB', + ], + 'Content' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。'."\n" + .'- 0：未开始'."\n" + .'- 1：运行中'."\n" + .'- 2：已暂停'."\n" + .'- 3：已终止'."\n" + .'- 200：已完成', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"71064826-726F-4ADA-B879-05D8055476FB\\",\\n \\"Content\\": {\\n \\"Status\\": 200\\n }\\n}","type":"json"}]', + 'title' => 'Get Identification Task Status', + 'description' => '## QPS Limit'."\n" + .'The QPS limit for this interface per user is 10 times/second. Exceeding the limit will result in API calls being rate-limited, which may affect your business. Please call it reasonably.', + 'translator' => 'machine', + ], + 'RestoreOssImage' => [ + 'summary' => '图片复原', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUXEIF', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Bucket', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-sddp', + ], + ], + [ + 'name' => 'ObjectKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun_dsc_desensitization/dir1/test.png', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TargetObjectKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_dsc_original /dir1/test.png'."\n", + 'default' => 'aliyun_dsc_original', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '208B016D-4CB9-4A85-96A5-0B8ED1EBF271', + ], + 'RestoredImageKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aliyun_dsc_original /dir1/test.png', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"208B016D-4CB9-4A85-96A5-0B8ED1EBF271\\",\\n \\"RestoredImageKey\\": \\"aliyun_dsc_original /dir1/test.png\\"\\n}","type":"json"}]', + ], + 'MaskOssImage' => [ + 'summary' => 'OSS图片脱敏', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsddpIUXEIF', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'sddp-api-demo-bucket', + ], + ], + [ + 'name' => 'ObjectKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dir1/test.png', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaskRuleIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '3000,3002', + ], + ], + [ + 'name' => 'IsSupportRestore', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'IsAlwaysUpload', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '136082B3-B21F-5E9D-B68E-991FFD205D24', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"136082B3-B21F-5E9D-B68E-991FFD205D24\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'sddp-api.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'sddp.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'sddp.cn-hangzhou-internal-prod-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'sddp.cn-zhangjiakou.aliyuncs.com', + ], + ], +]; |