All Products
Search
Document Center

Data Security Center:DescribeDataLimits

Last Updated:Mar 26, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Valid values:

  • zh: Chinese
  • en: English
zh
PageSizeintegerNo

The number of entries to return on each page.

10
CurrentPageintegerNo

The number of the page to return.

1
ResourceTypeintegerNo

The type of the service to which the data asset to be queried belongs. Valid values:

  • 1: MaxCompute
  • 2: Object Storage Service (OSS)
  • 3: AnalyticDB for MySQL
  • 4: Tablestore
  • 5: ApsaraDB RDS
  • 6: self-managed database
1
ParentIdstringNo

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
ServiceRegionIdstringNo

The region in which the data asset resides.

cn-hangzhou
CheckStatusintegerNo

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
AuditStatusintegerNo

Specifies whether to enable the security audit feature. Valid values:

  • 1: yes
  • 0: no
1
EngineTypestringNo

The type of the database engine. Valid values include MySQL, SQLServer, Oracle, PostgreSQL, and MongoDB.

MySQL
DatamaskStatusintegerNo

Specifies whether DSC has the data de-identification permissions on the data asset. Valid values:

  • 1: yes
  • 0: no
1
EnableintegerNo

Specifies whether DSC has the data detection permissions on the data asset. Valid values:

  • 1: yes
  • 0: no
1
StartTimelongNo

The beginning of the time range to query The value is a UNIX timestamp. Unit: milliseconds.

1616068534877
EndTimelongNo

The end of the time range to query The value is a UNIX timestamp. Unit: milliseconds.

1616068534877
FeatureTypeintegerNo

This parameter is deprecated.

2

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

769FB3C1-F4C9-42DF-9B72-7077A8989***
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of entries returned.

200
Itemsobject []

An array that consists of the data assets.

SupportEventboolean

Indicates whether anomalous event detection is supported. Valid values:

  • true: yes
  • false: no
true
ErrorMessagestring

The reason for the failure.

The password is invalid.
CheckStatusinteger

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
LocalNamestring

The region in which the data asset resides.

China (Hangzhou)
TenantNamestring

The alias of the tenant.

insta_gram
NextStartTimelong

The next time when the data asset is scanned. The value is a UNIX timestamp. Unit: milliseconds.

1676620236000
Portinteger

The port number of the self-managed database.

3306
CheckStatusNamestring

The name of the data detection status.

Connectivity test status
SamplingSizeinteger

The number of sensitive data samples. Valid values: 0, 5, and 10. Unit: data entries.

5
ParentIdstring

The parent ID of the data asset. Valid values include bucket, db, and project.

project
DatamaskStatusinteger

Indicates whether DSC has the data de-identification permissions on the data asset. Valid values:

  • 1: yes
  • 0: no
1
ProcessTotalCountinteger

The total number of data tables or files.

100
ResourceTypelong

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
ErrorCodestring

The error code that is returned.

connect_network_error
OcrStatusinteger

Indicates whether the optical character recognition (OCR) feature is enabled. Valid values:

  • 0: no
  • 1: yes
1
LogStoreDayinteger

The retention period of raw logs. Unit: days.

30
EventStatusinteger

Indicates whether the data leak prevention feature is enabled. Valid values:

  • 0: no
  • 1: yes (default value)
1
SupportScanboolean

Indicates whether the data asset scan feature is supported. Valid values:

  • true: yes
  • false: no
true
LastFinishedTimelong

The time when the last scan was finished.

  • The value is a UNIX timestamp.
  • Unit: milliseconds.
145600000
UserNamestring

The username that is used to access the data asset.

tsts
AuditStatusinteger

Indicates whether the security audit feature is enabled. Valid values:

  • 1: yes
  • 0: no
1
SupportOcrboolean

Indicates whether OCR is supported. Valid values:

  • true: yes
  • false: no
true
EngineTypestring

The type of the database engine. Valid values include MySQL, SQLServer, Oracle, PostgreSQL, and MongoDB.

MySQL
InstanceIdstring

The ID of the instance to which the table belongs.

12332
TotalCountinteger

The total number of fields in the table.

100
InstanceDescriptionstring

The description of the instance.

123
DbVersionstring

The database engine version of the instance.

2.0
RegionIdstring

The region in which the data asset resides.

cn-hangzhou
GmtCreatelong

The time when the data asset was created. The value is a UNIX timestamp. Unit: milliseconds.

145600000
SupportAuditboolean

Indicates whether the security audit feature is supported. Valid values:

  • true: yes
  • false: no
true
AutoScaninteger

Indicates whether the data asset can be automatically scanned. Valid values:

  • 0: no
  • 1: yes
1
ResourceTypeCodestring

The code of the service to which the data asset belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

RDS
SupportDatamaskboolean

Indicates whether data de-identification is supported. Valid values:

  • true: yes
  • false: no
true
ProcessStatusinteger

The status of the data asset scan. Valid values:

  • -1: invalid
  • 0: waiting
  • 1: being scanned
  • 2: suspended
  • 3: completed
3
Idlong

The ID of the data asset.

1
Enableinteger

Indicates whether DSC has the data detection permissions on the data asset. Valid values:

  • 1: yes
  • 0: no
1
SecurityGroupIdListarray

The array consisting of the IDs of the security groups that are used by PrivateLink when you install the DSC agent.

string

The ID of the security group that is used by PrivateLink when you install the DSC agent.

sg-bp113yf20quxkvy****
VSwitchIdListarray

The array consisting of the IDs of the vSwitches that are used by PrivateLink when you install the DSC agent.

string

The ID of the vSwitch that is used by PrivateLink when you install the DSC agent.

vsw-bp1kk2mtrtey7o4ju****
VpcIdstring

The ID of the virtual private cloud (VPC) to which the data asset belongs.

vpc-2zevcqke6hh09c41****

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****"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-25The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: FeatureType
2022-07-18API Description Update. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Output ParametersThe response structure of the API has changed.