All Products
Search
Document Center

Data Security Center:DescribeDataLimitDetail

Last Updated:Mar 26, 2024

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.

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: Simplified Chinese.
  • en: English
zh
IdlongYes

The unique ID of the data asset that you want to query.

Note You can call the DescribeDataLimits operation to query the ID of the data asset.
12300
NetworkTypeintegerNo

The network type of the data asset that you want to query. Valid values:

  • 1: virtual private cloud (VPC)
  • 2: classic network
1
FeatureTypeintegerNo

This parameter is deprecated.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

769FB3C1-F4C9-42DF-9B72-7077A8989C13
DataLimitobject

The details of the data asset.

LocalNamestring

The region in which the data asset resides.

China (Qingdao)
CheckStatusinteger

The status of the connectivity test between the data asset and DSC. Valid values:

  • 2: indicates that the data asset was being connected.
  • 3: indicates that the data asset was connected to DSC.
  • 4: indicates that the data asset failed to be connected.
3
Portinteger

The port number that is used to connect to the database.

3306
CheckStatusNamestring

The result that indicates the status of the connectivity test between the data asset and DSC. Valid values:

  • Passed
  • Failed
  • Testing
Passed
RegionIdstring

The ID of the region in which the data asset resides.

cn-qingdao
ParentIdstring

The ID and name of the data asset in the service to which the data asset belongs.

rm-m5eup49p6o274****.RDS_example
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
1
GmtCreatelong

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

145600000
ResourceTypeCodestring

The service to which the data asset belongs. Valid values:

  • MaxCompute
  • OSS
  • ADS
  • OTS
  • RDS
RDS
UserNamestring

The account of the user who manages the data asset.

User01
Idlong

The ID of the data asset.

12300

Examples

Sample success responses

JSONformat

{
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "DataLimit": {
    "LocalName": "China (Qingdao)\n",
    "CheckStatus": 3,
    "Port": 3306,
    "CheckStatusName": "Passed\n",
    "RegionId": "cn-qingdao",
    "ParentId": "rm-m5eup49p6o274****.RDS_example",
    "ResourceType": 1,
    "GmtCreate": 145600000,
    "ResourceTypeCode": "RDS",
    "UserName": "User01",
    "Id": 12300
  }
}

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