DescribeDataLimits - Data Security Center - Alibaba Cloud Documentation Center

Queries the data assets such as instances, databases, or buckets that Data Security Center (DSC) is authorized to access.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sddp:DescribeDataLimits	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Valid values: zh: Chinese en: English	zh
PageSize	integer	No	The number of entries to return on each page.	10
CurrentPage	integer	No	The number of the page to return.	1
ResourceType	integer	No	The type of the service to which the data asset belongs. This parameter is required. Valid values: 1: MaxCompute 2: Object Storage Service (OSS) 3: AnalyticDB for MySQL 4: Tablestore 5: ApsaraDB RDS 6: self-managed database	1
ParentId	string	No	The parent ID of the data asset to be queried. Valid values: The name or ID of the MaxCompute project. The name or ID of the OSS bucket. The name or ID of the ApsaraDB RDS instance or database.	1112
ServiceRegionId	string	No	The region in which the data asset resides.	cn-hangzhou
CheckStatus	integer	No	The data detection status. Valid values: 0: The data detection is ready. 1: The data detection is running. 2: The connectivity test is in progress. 3: The connectivity test passed. 4: The connectivity test failed.	3
AuditStatus	integer	No	Specifies whether to enable the security audit feature. Valid values: 1: yes 0: no	1
EngineType	string	No	The type of the database engine. Valid values include MySQL, SQLServer, Oracle, PostgreSQL, and MongoDB.	MySQL
DatamaskStatus	integer	No	Specifies whether DSC has the data de-identification permissions on the data asset. Valid values: 1: yes 0: no	1
Enable	integer	No	Specifies whether DSC has the data detection permissions on the data asset. Valid values: 1: yes 0: no	1
StartTime	long	No	The beginning of the time range to query The value is a UNIX timestamp. Unit: milliseconds.	1616068534877
EndTime	long	No	The end of the time range to query The value is a UNIX timestamp. Unit: milliseconds.	1616068534877
MemberAccount	long	No	The ID of the member.	**********8103
FeatureType	integer	No	This parameter is deprecated.	2

Response parameters

Parameter	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	769FB3C1-F4C9-42DF-9B72-7077A8989***
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	200
Items	array<object>	A list of data assets.
DataLimit	object	The details of the data asset.
SupportEvent	boolean	Indicates whether anomalous event detection is supported. Valid values: true false	true
ErrorMessage	string	The reason for the failure.	The password is invalid.
CheckStatus	integer	The data detection status. Valid values: 0: The data detection is ready. 1: The data detection is running. 2: The connectivity test is in progress. 3: The connectivity test is passed. 4: The connectivity test failed.	3
LocalName	string	The region in which the data asset resides.	China (Hangzhou)
TenantName	string	The alias of the tenant.	insta_gram
NextStartTime	long	The next time when the data asset is scanned. The value is a UNIX timestamp. Unit: milliseconds.	1676620236000
Port	integer	The port number of the self-managed database.	3306
CheckStatusName	string	The name of the data detection status.	Connectivity test status
SamplingSize	integer	The number of sensitive data samples. Valid values: 0, 5, and 10. Unit: data entries.	5
ParentId	string	The parent ID of the data asset that you want to query. Valid values include bucket, db, and project.	project
DatamaskStatus	integer	Indicates whether DSC has the data de-identification permissions on the data asset. Valid values: 1: yes 0: no	1
ProcessTotalCount	integer	The total number of data tables or files.	100
ResourceType	long	The type of the service to which the data asset belongs. Valid values: 1: MaxCompute 2: OSS 3: AnalyticDB for MySQL 4: Tablestore 5: ApsaraDB RDS 6: self-managed database	5
ErrorCode	string	The error code.	connect_network_error
OcrStatus	integer	Indicates whether the optical character recognition (OCR) feature is enabled. Valid values: 0: no 1: yes	1
LogStoreDay	integer	The retention period of raw logs. Unit: days.	30
EventStatus	integer	Indicates whether the data leak prevention feature is enabled. Valid values: 0: no 1: yes (default)	1
SupportScan	boolean	Indicates whether the data asset scan feature is supported. Valid values: true: yes false: no	true
LastFinishedTime	long	The time when the last scan is performed. The value is a UNIX timestamp. Unit: milliseconds.	145600000
UserName	string	The username that is used to access the data asset.	tsts
AuditStatus	integer	Indicates whether the security audit feature is enabled. Valid values: 1: yes 0: no	1
SupportOcr	boolean	Indicates whether OCR is supported. Valid values: true: yes false: no	true
EngineType	string	The type of the database engine. Valid values include MySQL, SQLServer, Oracle, PostgreSQL, and MongoDB.	MySQL
InstanceId	string	The ID of the data asset to which the table belongs.	12332
TotalCount	integer	The total number of fields in the table.	100
InstanceDescription	string	The description of the instance.	123
DbVersion	string	The database engine version.	2.0
RegionId	string	The region in which the asset resides.	cn-hangzhou
GmtCreate	long	The time when the data asset was created. The value is a UNIX timestamp. Unit: milliseconds.	145600000
SupportAudit	boolean	Indicates whether the security audit feature is supported. Valid values: true: yes false: no	true
AutoScan	integer	Indicates whether the data asset can be automatically scanned. Valid values: 0: no 1: yes	1
ResourceTypeCode	string	The code of the service to which the data asset belongs. Valid values: MaxCompute, OSS, ADS, OTS, and RDS.	RDS
SupportDatamask	boolean	Indicates whether the data de-identification feature is supported. Valid values: true: yes false: no	true
ProcessStatus	integer	The status of the data asset scan. Valid values: -1: invalid 0: waiting 1: being scanned 2: suspended 3: completed	3
Id	long	The unique ID of the data asset.	1
Enable	integer	Indicates whether DSC has the data identification permissions on the data asset. Valid values: 1: yes 0: no	1
SecurityGroupIdList	array	A list of the IDs of the security groups that are used by PrivateLink when you install the DSC agent.
seucurityGroup	string	The ID of the security group that is used by PrivateLink when you install the DSC agent.	sg-bp113yf20quxkvy****
VSwitchIdList	array	A list of the IDs of the vSwitches that are used by PrivateLink when you install the DSC agent.
vSwitch	string	The ID of the vSwitch that is used by PrivateLink when you install the DSC agent.	vsw-bp1kk2mtrtey7o4ju****
VpcId	string	The ID of the virtual private cloud (VPC) to which the data asset belongs.	vpc-2zevcqke6hh09c41****
MemberAccount	long	The ID of the member.	**********8103

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989***",
  "PageSize": 10,
  "TotalCount": 200,
  "Items": [
    {
      "SupportEvent": true,
      "ErrorMessage": "The password is invalid.\n",
      "CheckStatus": 3,
      "LocalName": "China (Hangzhou)\n",
      "TenantName": "insta_gram",
      "NextStartTime": 1676620236000,
      "Port": 3306,
      "CheckStatusName": "Connectivity test status\n",
      "SamplingSize": 5,
      "ParentId": "project",
      "DatamaskStatus": 1,
      "ProcessTotalCount": 100,
      "ResourceType": 5,
      "ErrorCode": "connect_network_error",
      "OcrStatus": 1,
      "LogStoreDay": 30,
      "EventStatus": 1,
      "SupportScan": true,
      "LastFinishedTime": 145600000,
      "UserName": "tsts",
      "AuditStatus": 1,
      "SupportOcr": true,
      "EngineType": "MySQL",
      "InstanceId": "12332",
      "TotalCount": 100,
      "InstanceDescription": "123",
      "DbVersion": "2.0",
      "RegionId": "cn-hangzhou",
      "GmtCreate": 145600000,
      "SupportAudit": true,
      "AutoScan": 1,
      "ResourceTypeCode": "RDS",
      "SupportDatamask": true,
      "ProcessStatus": 3,
      "Id": 1,
      "Enable": 1,
      "SecurityGroupIdList": [
        "sg-bp113yf20quxkvy****"
      ],
      "VSwitchIdList": [
        "vsw-bp1kk2mtrtey7o4ju****"
      ],
      "VpcId": "vpc-2zevcqke6hh09c41****",
      "MemberAccount": 0
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-09	The response structure of the API has changed	View Change Details
2024-04-18	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-03-25	The request parameters of the API has changed	View Change Details
2022-07-18	API Description Update. The response structure of the API has changed	View Change Details