Queries the details of a data asset that you authorize Data Security Center (DSC) to access. The data asset can be an instance, a database, or an Object Storage Service (OSS) bucket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDataLimitDetail

The operation that you want to perform.

Set the value to DescribeDataLimitDetail.

Lang String No zh

The language of the request and response. Valid values:

  • zh: simplified Chinese.
  • en: English. This is the default value.
Id Long Yes 12300

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.
NetworkType Integer No 1

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

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

Common request parameters must be included in all DSC API requests. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String 769FB3C1-F4C9-42DF-9B72-7077A8989C13

The ID of the request. You can troubleshoot issues based on the ID of the request.

DataLimit Object

The details of the data asset.

LocalName String China (Qingdao)

The region in which the data asset resides.

CheckStatus Integer 3

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.
Port Integer 3306

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

CheckStatusName String Pass

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

  • Pass
  • Fail
  • Testing
RegionId String cn-qingdao

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

ParentId String rm-m5eup49p6o274****.RDS_example

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

ResourceType Long 1

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
GmtCreate Long 145600000

The time when the data asset was connected to DSC. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

ResourceTypeCode String RDS

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

  • MaxCompute
  • OSS
  • ADS
  • OTS
  • RDS
UserName String User01

The account of the user who manages the data asset.

Id Long 12300

The unique ID of the data asset.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDataLimitDetail
&Lang=zh
&Id=12300
&NetworkType=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDataLimitDetailResponse>
    <RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>
    <DataLimit>
        <LocalName>China (Qingdao)</LocalName>
        <CheckStatus>3</CheckStatus>
        <Port>3306</Port>
        <CheckStatusName>Pass</CheckStatusName>
        <RegionId>cn-qingdao</RegionId>
        <ParentId>rm-m5eup49p6o274****.RDS_example</ParentId>
        <ResourceType>1</ResourceType>
        <GmtCreate>145600000</GmtCreate>
        <ResourceTypeCode>RDS</ResourceTypeCode>
        <UserName>User01</UserName>
        <Id>12300</Id>
    </DataLimit>
</DescribeDataLimitDetailResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "DataLimit" : {
    "LocalName": "China (Qingdao)",
    "CheckStatus" : 3,
    "Port" : 3306,
    "CheckStatusName" : "Pass",
    "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 API Error Center.