All Products
Search
Document Center

Data Security Center:DescribeDataLimitSet

Last Updated:Oct 17, 2024

Queries a list of assets that Data Security Center (DSC) is authorized to scan or a list of regions that are supported by DSC.

Operation description

You can call this operation to query the data assets that are authorized to be scanned. This facilitates resource search and aggregation.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sddp:DescribeDataLimitSetget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh_cn: Simplified Chinese (default)
  • en_us: English
zh_cn
ResourceTypeintegerNo

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

  • 1: MaxCompute
  • 2: OSS
  • 3: AnalyticDB for MySQL
  • 4: Tablestore
  • 5: ApsaraDB RDS
2
ParentIdstringNo

The parent asset ID of the data asset.

You can call the DescribeDataLimitDetail or DescribeDataLimits operation to obtain the parent asset ID of the data asset from the value of the ParentId parameter.

db
FeatureTypeintegerNo

This parameter is deprecated.

2

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The information about the data asset.

ResourceTypeCodestring

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

  • ODPS
  • OSS
  • ADS
  • OTS
  • RDS
OSS
ResourceTypelong

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

  • 1: MaxCompute
  • 2: OSS
  • 3: AnalyticDB for MySQL
  • 4: Tablestore
  • 5: ApsaraDB RDS
2
TotalCountinteger

The total number of data objects in the data assets.

10
DataLimitListarray<object>

An array that consists of data assets that DSC is authorized to scan.

DataLimitobject
LocalNamestring

The region in which the data asset resides.

China (Hangzhou)
CheckStatusinteger

Indicates whether the test of connectivity between DSC and the data asset is passed.

  • 2: The connectivity test is in progress.
  • 3: The connectivity test is passed.
  • 4: The connectivity test failed.
3
Connectorstring

The connection string that is used to access the data asset.

Connection string
CheckStatusNamestring

The name of the data detection status.

Connectivity test status
RegionIdstring

The region in which the data asset resides.

cn-****
ParentIdstring

The parent asset ID of the data asset.

db
ResourceTypelong

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

  • 1: MaxCompute
  • 2: OSS
  • 3: AnalyticDB for MySQL
  • 4: Tablestore
  • 5: ApsaraDB RDS
2
GmtCreatelong

The time when the data asset was created. Unit: milliseconds.

1625587423000
ResourceTypeCodestring

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

  • ODPS
  • OSS
  • ADS
  • OTS
  • RDS
OSS
UserNamestring

The username that is used to access the data asset.

tsts
Idlong

The ID of the data asset.

1
OssBucketListarray<object>

An array consisting of the OSS objects that DSC is authorized to scan.

OssBucketobject
RegionIdstring

The region ID of the OSS object.

cn-****
BucketNamestring

The name of the OSS bucket to which the OSS object belongs.

oss-bucket
RegionListarray<object>

An array consisting of the regions in which the data assets can be scanned.

Regionobject
RegionIdstring

The ID of the region.

cn-****
LocalNamestring

The name of the region.

China (Hangzhou)

Examples

Sample success responses

JSONformat

{
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "DataLimitSet": {
    "ResourceTypeCode": "OSS",
    "ResourceType": 2,
    "TotalCount": 10,
    "DataLimitList": [
      {
        "LocalName": "China (Hangzhou)\n",
        "CheckStatus": 3,
        "Connector": "Connection string\n",
        "CheckStatusName": "Connectivity test status\n",
        "RegionId": "cn-****",
        "ParentId": "db",
        "ResourceType": 2,
        "GmtCreate": 1625587423000,
        "ResourceTypeCode": "OSS",
        "UserName": "tsts",
        "Id": 1
      }
    ],
    "OssBucketList": [
      {
        "RegionId": "cn-****",
        "BucketName": "oss-bucket"
      }
    ],
    "RegionList": [
      {
        "RegionId": "cn-****",
        "LocalName": "China (Hangzhou)\n"
      }
    ]
  }
}

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 changedView Change Details