All Products
Search

This Product

    Data Security Center:DescribeInstances

    Document Center

    Data Security Center:DescribeInstances

    Last Updated:Feb 27, 2024

    Queries data assets such as MaxCompute, ApsaraDB RDS, and Object Storage Service (OSS) that you authorize Data Security Center (DSC) to access.

    Operation description

    When you call the DescribeInstances operation, you can specify parameters such as Name and RiskLevelId to query data assets that meet filter conditions.

    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

    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. Default value: zh_cn. Valid values:

    • zh_cn: Simplified Chinese
    • en_us: English
    		zh_cn
    NamestringNo

    The keyword that is used to search for data assets. DSC searches for data assets based on the keyword that you specify in fuzzy match mode. For example, if you specify data, all data assets whose names contain data are queried.

    		data
    ProductIdlongNo

    The ID of the service to which the data asset belongs. You can call the DescribeDataAssets operation to query the ID of the service.

    		1
    RiskLevelIdlongNo

    The sensitivity level ID of the data asset. A higher sensitivity level indicates that the identified data is more sensitive. Valid values:

    • 1: No sensitive data is identified.
    • 2: sensitive data at level 1.
    • 3: sensitive data at level 2.
    • 4: sensitive data at level 3
    • 5: sensitive data at level 4.
    • 6: sensitive data at level 5.
    • 7: sensitive data at level 6.
    • 8: sensitive data at level 7.
    • 9: sensitive data at level 8.
    • 10: sensitive data at level 9.
    • 11: sensitive data at level 10.
    		2
    RuleIdlongNo

    The ID of the sensitive data detection rule that the data asset hits. You can call the DescribeRules operation and obtain the ID of the sensitive data detection rule from the Id response parameter.

    		1111111
    ServiceRegionIdstringNo

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

    		cn-hangzhou
    FeatureTypeintegerNo

    This parameter is deprecated.

    		1
    ProductCodestringNo

    The name of the service to which the data asset belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets from which DSC can scan for sensitive data, see Supported data assets.

    		RDS
    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

    Response parameters

    ParameterTypeDescriptionExample
    object
    CurrentPageinteger

    The page number of the returned page.

    		1
    RequestIdstring

    The ID of the request.

    		71064826-726F-4ADA-B879-05D8055476FB
    PageSizeinteger

    The number of entries returned per page.

    		10
    TotalCountinteger

    The total number of data assets.

    		231
    Itemsobject []

    An array that consists of the data assets.

    CreationTimelong

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

    		1637226782000
    LastFinishTimelong

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

    		1637622793000
    Ownerstring

    The Alibaba Cloud account to which the data asset belongs.

    		dtdep-239-******
    TenantNamestring

    The name of the tenant.

    		Tenant 1
    Protectionboolean

    The protection status of the data asset. Valid values:

    • true: The data asset is being protected.
    • false: The data asset is not protected.
    		false
    DepartNamestring

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

    		***DemoCenter
    Labelsecboolean

    The security status of the data asset. Valid values:

    • true: The data asset is secure.
    • false: The data asset is insecure.
    		true
    RiskLevelIdlong

    The ID of the sensitivity level for the data asset. A higher sensitivity level ID indicates that the identified data is more sensitive.

    • 1: No sensitive data is detected.
    • 2: sensitive data at level 1.
    • 3: sensitive data at level 2.
    • 4: sensitive data at level 3.
    • 5: sensitive data at level 4.
    • 6: sensitive data at level 5.
    • 7: sensitive data at level 6.
    • 8: sensitive data at level 7.
    • 9: sensitive data at level 8.
    • 10: sensitive data at level 9.
    • 11: sensitive data at level 10.
    		2
    ProductIdstring

    The ID of the service to which the data asset belongs.

    		5
    Namestring

    The name of the data asset.

    		gxdata
    TotalCountinteger

    The total number of data objects in the data asset. For example, if the data asset is an ApsaraDB RDS instance, the value indicates the total number of tables in all databases of the instance.

    		231
    InstanceDescriptionstring

    The description of the data asset.

    		Data asset Information 1
    RuleNamestring

    The name of the sensitive data detection rule that the data asset hits.

    		\*\*\* rule
    Sensitiveboolean

    Indicates whether the data asset contains sensitive data. Valid values:

    • true
    • false
    		true
    RiskLevelNamestring

    The name of the sensitivity level for the data asset.

    		Sensitive data at level 1
    OdpsRiskLevelNamestring

    This parameter is deprecated.

    		1
    SensitiveCountinteger

    The number of sensitive data objects in the data asset. For example, if the data asset is an ApsaraDB RDS instance, the value indicates the number of sensitive tables in all databases of the instance.

    		123
    Idlong

    The unique ID of the data asset in DSC.

    		11111
    ProductCodestring

    The name of the service to which the data asset belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets that DSC can scan to detect sensitive data, see Supported data assets.

    		RDS
    ModelTagsobject []

    A list of tags.

    Idlong

    The ID of the tag. Valid values:

    • 101: personal sensitive information
    • 102: personal information
    • 107: general information
    		101
    Namestring

    The name of the tag. Valid values:

    • Personal sensitive information
    • Personal information
    • General information
    		personal sensitive data

    Examples

    Sample success responses

    JSONformat

    {
  "CurrentPage": 1,
  "RequestId": "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize": 10,
  "TotalCount": 231,
  "Items": [
    {
      "CreationTime": 1637226782000,
      "LastFinishTime": 1637622793000,
      "Owner": "dtdep-239-******",
      "TenantName": "Tenant 1\n",
      "Protection": false,
      "DepartName": "***DemoCenter",
      "Labelsec": true,
      "RiskLevelId": 2,
      "ProductId": "5",
      "Name": "gxdata",
      "TotalCount": 231,
      "InstanceDescription": "Data asset Information 1\n",
      "RuleName": "\\*\\*\\* rule\n",
      "Sensitive": true,
      "RiskLevelName": "Sensitive data at level 1\n",
      "OdpsRiskLevelName": "1",
      "SensitiveCount": 123,
      "Id": 11111,
      "ProductCode": "RDS",
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ]
    }
  ]
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.