DescribeInstances - Data Security Center - Alibaba Cloud Documentation Center

Retrieves a list of authorized MaxCompute, RDS, and OSS data asset instances.

Operation description

When you call the DescribeInstances operation, you can set parameters such as search keywords and the threat level of data asset instances to retrieve a list of instances that meet your requirements.

QPS limit

The queries per second (QPS) limit for a single user for this operation is 10 calls per second. If you exceed this limit, API calls are throttled. This can affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sddp:DescribeInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese en_us: English	zh_cn
Name	string	No	The keyword to search for. Fuzzy match is supported. For example, if you enter "data", all data that contains "data" is returned.	data
ProductId	integer	No	The ID of the product to which the data asset instance belongs. You can call the DescribeDataAssets operation to query the product ID.	1
RiskLevelId	integer	No	The ID of the threat level for the data asset instance. The higher the threat level ID, the more sensitive the data. Valid values: 1: No sensitive data is detected. No threat. 2: Threat level 1. 3: Threat level 2. 4: Threat level 3. 5: Threat level 4. 6: Threat level 5. 7: Threat level 6. 8: Threat level 7. 9: Threat level 8. 10: Threat level 9. 11: Threat level 10.	2
RuleId	integer	No	The ID of the sensitive data detection rule that the data asset instance hits. You can call the DescribeRules operation and view the value of the Id parameter in the response to obtain the rule ID.	1111111
ServiceRegionId	string	No	The region where the data asset instance resides. For more information, see Supported regions.	cn-hangzhou
FeatureType	integer	No	This parameter is deprecated.	1
ProductCode	string	No	The name of the product to which the data asset instance belongs, such as MaxCompute, OSS, or RDS. For more information about the supported products, see Data assets that can be scanned for sensitive data.	RDS
PageSize	integer	No	The maximum number of data asset instances to return on each page of a paged query. Default value: 10.	10
CurrentPage	integer	No	The page number of the paged query. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number.	1
RequestId	string	The ID of the request.	71064826-726F-4ADA-B879-05D8055476FB
PageSize	integer	The number of data asset instances returned on each page.	10
TotalCount	integer	The total number of data asset instances.	231
Items	array<object>	The details of the data asset instances.
	array<object>
CreationTime	integer	The time when the data asset instance was created. The value is a UNIX timestamp. Unit: milliseconds.	1637226782000
LastFinishTime	integer	The time when the last scan of the data asset instance was completed. The value is a UNIX timestamp. Unit: milliseconds.	1637622793000
Owner	string	The Alibaba Cloud account that owns the data asset instance.	dtdep-239-******
TenantName	string	The name of the tenant.	tenant
Protection	boolean	The protection status of the data asset instance. Valid values: true: The instance is protected. false: The instance is not protected.	false
DepartName	string	The name of the department to which the data asset instance belongs.	***DemoCenter
Labelsec	boolean	The security status of the data asset instance. Valid values: true: secure false: insecure	true
RiskLevelId	integer	The ID of the threat level for the data asset instance. The higher the threat level ID, the more sensitive the data. 1: No sensitive data is detected. No threat. 2: Threat level 1. 3: Threat level 2. 4: Threat level 3. 5: Threat level 4. 6: Threat level 5. 7: Threat level 6. 8: Threat level 7. 9: Threat level 8. 10: Threat level 9. 11: Threat level 10.	2
ProductId	string	The ID of the product to which the data asset instance belongs.	5
Name	string	The name of the data asset instance.	gxdata
TotalCount	integer	The total amount of data in the data asset instance. For example, if the data asset is an RDS instance, this parameter indicates the total number of tables in the instance.	231
InstanceDescription	string	The description of the data asset instance.	instance dscription
RuleName	string	The name of the sensitive data detection rule that the data asset instance hits.	*** rule
Sensitive	boolean	Indicates whether the data asset instance contains sensitive data. Valid values: true: yes false: no	true
RiskLevelName	string	The name of the threat level for the data asset instance.	S1
OdpsRiskLevelName	string	This parameter is deprecated.	1
SensitiveCount	integer	The total amount of sensitive data in the data asset instance. For example, if the data asset is an RDS instance, this parameter indicates the total number of sensitive tables in the instance.	123
Id	integer	The unique ID of the data asset instance that is recorded in Data Security Center.	11111
ProductCode	string	The name of the product to which the data asset instance belongs, such as MaxCompute, OSS, or RDS. For more information about the supported products, see Data assets that can be scanned for sensitive data.	RDS
ModelTags	array<object>	The list of data labels.
	object	The data label object.
Id	integer	The ID of the data label. Valid values: 101: Personal sensitive information 102: Personal information 107: General information	101
Name	string	The name of the data label. Valid values: Personal sensitive information Personal information General information	personal sensitive data
MemberAliUid	string	If multi-account management is enabled and the asset belongs to a member account, this parameter indicates the UID of the member account.	12567890126

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.