All Products
Search
Document Center

Data Security Center:DescribeInstanceSources

Last Updated:Mar 26, 2024

Queries a list of data assets.

Operation description

You can query a list of unauthorized or authorized data assets based on the value of AuthStatus.

This operation is no longer used for the KMS console of the new version.

QPS limits

This operation can be called up to 10 times per second for each Alibaba Cloud account. If the number of 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

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_cn: Simplified Chinese (default)
  • en_us: English
zh_cn
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
ServiceRegionIdstringNo

The region in which the data asset resides. For more information, see Supported regions.

cn-hangzhou
EngineTypestringNo

The type of the database engine. Valid values: MySQL, MariaDB, Oracle, PostgreSQL, and SQLServer.

MySQL
InstanceIdstringNo

The ID of the instance.

instance-demo-****
ProductIdlongNo

The ID of the service to which the data asset to query belongs. Valid values: 1, 2, 3, 4, and 5. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.

1
ProductCodestringNo

The name of the service to which the data asset to query belongs. Valid values: MaxCompute, OSS, ADS, OTS, and RDS.

MaxCompute
AuditStatusintegerNo

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

  • 1: yes
  • 0: no
1
SearchTypestringNo

The data asset type based on which a fuzzy search is performed.

  • InstanceId: the ID of the instance.
  • InstanceName: the name of the instance.
  • DatabaseName: the name of the database.
InstanceId
SearchKeystringNo

The content based on which a fuzzy search is performed.

1
AuthStatusintegerNo

Specifies whether DSC is authorized to access the data asset.

  • 0: no
  • 1: yes
0
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, which is used to locate and troubleshoot issues.

5A7E8FB9-5011-5A90-97D9-AE587047****
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of entries returned.

2
Itemsobject []

An array that consists of the queried data assets.

LastModifyUserIdstring

The ID of the account that is last used to modify the data asset.

demo
PasswordStatusinteger

Indicates whether the password is used. Valid values:

  • 1: yes
  • 0: no
1
EngineTypestring

The type of the database engine. Valid values: MySQL, MariaDB, Oracle, PostgreSQL, and SQLServer.

MySQL
TenantNamestring

The name of the tenant.

user1
InstanceIdstring

The ID of the instance

rm-****
InstanceDescriptionstring

The description of the instance.

Test
RegionIdstring

The ID of the region where the instance resides.

cn-hangzhou
DbNamestring

The name of the database to which the data asset belongs.

demo
LastModifyTimelong

The time when the data asset was last modified. Unit: milliseconds.

1625587423000
RegionNamestring

The name of the region.

China (Hangzhou)
CanModifyUserNameboolean

Indicates whether the username and password can be changed. Valid values:

  • true: yes
  • false: no
true
LogStoreDayinteger

The retention period of raw logs. Unit: days.

30
GmtCreatelong

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

1625587423000
AutoScaninteger

Indicates whether the automatic scan feature is enabled to detect sensitive data. Valid values:

  • 0: no
  • 1: yes
0
ProductIdlong

The ID of the service to which the data asset belongs. Valid values include 1, 2, 3, 4, and 5. The value 1 indicates MaxCompute. The value 2 indicates OSS. The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.

2
InstanceSizelong

The storage space size of the instance. This parameter is valid only if the value of the ProductId parameter is 2. Unit: bytes.

409600
UserNamestring

The username of the account.

User01
AuditStatusinteger

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

  • 1: yes
  • 0: no
1
Idlong

The unique ID of the data asset.

1
TenantIdstring

The ID of the tenant.

11
Enableinteger

Indicates whether sensitive data detection is enabled for the data asset. Valid values:

  • 1: yes
  • 0: no
1
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
DatamaskStatusinteger

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

  • 1: yes
  • 0: no
1
ErrorMessagestring

The reason for the failure.

The password is invalid.
SamplingSizeinteger

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

10

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "5A7E8FB9-5011-5A90-97D9-AE587047****",
  "PageSize": 10,
  "TotalCount": 2,
  "Items": [
    {
      "LastModifyUserId": "demo",
      "PasswordStatus": 1,
      "EngineType": "MySQL",
      "TenantName": "user1",
      "InstanceId": "rm-****",
      "InstanceDescription": "Test\n",
      "RegionId": "cn-hangzhou",
      "DbName": "demo",
      "LastModifyTime": 1625587423000,
      "RegionName": "China (Hangzhou)\n",
      "CanModifyUserName": true,
      "LogStoreDay": 30,
      "GmtCreate": 1625587423000,
      "AutoScan": 0,
      "ProductId": 2,
      "InstanceSize": 409600,
      "UserName": "User01",
      "AuditStatus": 1,
      "Id": 1,
      "TenantId": "11",
      "Enable": 1,
      "CheckStatus": 3,
      "DatamaskStatus": 1,
      "ErrorMessage": "The password is invalid.\n",
      "SamplingSize": 10
    }
  ]
}

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