DescribeDataLimits - Data Security Center - Alibaba Cloud Documentation Center

Queries the list of data assets for authorized instances, databases, and buckets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sddp:DescribeDataLimits

get

*All Resource

*

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 page number to return.	1
ResourceType	integer	No	The type of service to which the data asset belongs. Data assets can be instances, databases, or buckets. Valid values: 1: MaxCompute 2: OSS 3: AnalyticDB for MySQL 4: Tablestore 5: RDS 6: A self-managed database	1
ParentId	string	No	The ID of the parent asset to which the data asset belongs. Valid values: The name or ID of a MaxCompute project. The name or ID of an OSS bucket. The name or ID of an RDS instance or database.	1112
ServiceRegionId	string	No	The ID of the region where the data asset is located.	cn-hangzhou
CheckStatus	integer	No	The connectivity test status. Valid values: 0: Ready. 1: Running. 2: Connectivity test in progress. 3: Connectivity test passed. 4: Connectivity test failed.	3
AuditStatus	integer	No	The audit status. Valid values: 1: Auditing enabled. 0: Auditing disabled.	1
EngineType	string	No	The type of the database engine. Examples: MySQL, SQLServer, Oracle, PostgreSQL, and MongoDB.	MySQL
DatamaskStatus	integer	No	The data masking status. Valid values: 1: Enabled. 0: Disabled.	1
Enable	integer	No	The sensitive data detection status. Valid values: 1: Enabled. 0: Disabled.	1
StartTime	integer	No	The beginning of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.	1616068534877
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.	1616068534877
MemberAccount	integer	No	The ID of the member account.	**********8103
FeatureType	integer	No	This parameter is deprecated.	2

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The 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.	200
Items	array<object>	A list of data assets.
	object	The details of the data asset.
SupportEvent	boolean	Indicates whether anomaly detection is supported. Valid values: true: Yes. false: No.	true
ErrorMessage	string	The error message that is returned if the connectivity test fails.	密码不正确
CheckStatus	integer	The connectivity test status. Valid values: 0: Ready. 1: Running. 2: Connectivity test in progress. 3: Connectivity test passed. 4: Connectivity test failed.	3
LocalName	string	The name of the region in which the data asset is located.	华东1（杭州）
TenantName	string	The alias of the tenant.	insta_gram
NextStartTime	integer	The time when the next scan is scheduled to start. This 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 connectivity test status.	联通性检测状态
SamplingSize	integer	The number of sensitive data samples. Valid values: 0, 5, and 10. Unit: entries.	5
ParentId	string	The ID of the parent asset, such as a bucket, DB, or project.	project
DatamaskStatus	integer	The data masking status. Valid values: 1: Enabled. 0: Disabled.	1
ProcessTotalCount	integer	The total number of data tables or files.	100
ResourceType	integer	The type of service to which the data asset belongs. Data assets can be instances, databases, or buckets. Valid values: 1: MaxCompute 2: OSS 3: AnalyticDB for MySQL 4: Tablestore 5: RDS 6: A self-managed database	5
ErrorCode	string	The error code that is returned if the connectivity test fails.	connect_network_error
OcrStatus	integer	The status of Optical Character Recognition (OCR). Valid values: 0: Disabled. 1: Enabled.	1
LogStoreDay	integer	The retention period of raw logs, in days.	30
EventStatus	integer	The anomaly detection status. Valid values: 0: Disabled. 1: Enabled (default).	1
SupportScan	boolean	Indicates whether sensitive data detection is supported. Valid values: true: Yes. false: No.	true
LastFinishedTime	integer	The time when the last full scan was complete. This value is a UNIX timestamp in milliseconds. Format: UNIX timestamp Unit: milliseconds	145600000
UserName	string	The username of the data asset owner.	tsts
AuditStatus	integer	The audit status. Valid values: 1: Auditing enabled. 0: Auditing disabled.	1
SupportOcr	boolean	Indicates whether OCR is supported. Valid values: true: Yes. false: No.	true
EngineType	string	The database engine type. Examples: MySQL, SQLServer, Oracle, PostgreSQL, and MongoDB.	MySQL
InstanceId	string	The ID of the instance to which the data asset belongs.	12332
TotalCount	integer	The total number of fields. This parameter is returned only when the data asset is a table.	100
InstanceDescription	string	The description of the instance.	123
DbVersion	string	The database version.	2.0
RegionId	string	The ID of the region in which the data asset is located.	cn-hangzhou
GmtCreate	integer	The time when the data asset was created. This value is a UNIX timestamp. Unit: milliseconds.	145600000
SupportAudit	boolean	Indicates whether auditing is supported. Valid values: true: Yes. false: No.	true
AutoScan	integer	Indicates whether automatic scanning is enabled. Valid values: 0: No. 1: Yes.	1
ResourceTypeCode	string	The code of the service to which the data asset belongs. Examples: MaxCompute, OSS, ADS, OTS, and RDS.	RDS
SupportDatamask	boolean	Indicates whether data masking is supported. Valid values: true: Yes. false: No.	true
ProcessStatus	integer	The status of the scan task. Valid values: -1: Invalid. 0: Pending. 1: Scanning. 2: Paused. 3: Completed.	3
Id	integer	The unique ID of the data asset.	1
Enable	integer	The sensitive data detection status. Valid values: 1: Enabled. 0: Disabled.	1
SecurityGroupIdList	array	A list of security group IDs that are used by PrivateLink for agent-based auditing.
	string	A security group ID that is used by PrivateLink for agent-based auditing.	sg-bp113yf20quxkvy****
VSwitchIdList	array	A list of vSwitch IDs that are used by PrivateLink for agent-based auditing.
	string	A vSwitch ID that is used by PrivateLink for agent-based auditing.	vsw-bp1kk2mtrtey7o4ju****
VpcId	string	The ID of the virtual private cloud (VPC) in which the data asset resides.	vpc-2zevcqke6hh09c41****
MemberAccount	integer	The ID of the member account to which the data asset belongs.	**********8103
LastStartTime	integer	The time when the last scan started. This value is a UNIX timestamp in milliseconds.	145600000

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989***",
  "PageSize": 10,
  "TotalCount": 200,
  "Items": [
    {
      "SupportEvent": true,
      "ErrorMessage": "密码不正确",
      "CheckStatus": 3,
      "LocalName": "华东1（杭州）",
      "TenantName": "insta_gram",
      "NextStartTime": 1676620236000,
      "Port": 3306,
      "CheckStatusName": "联通性检测状态",
      "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,
      "LastStartTime": 145600000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.