You can call this operation to query MaxCompute, Relational Database Service (RDS), or Object Storage Service (OSS) instances that you authorize Sensitive Data Discovery and Protection (SDDP) to access.

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 DescribeInstances

The operation that you want to perform. Set the value to DescribeInstances.
CurrentPage Integer No 1

The number of the page to return.
FeatureType Integer No 0

Ignore this parameter.
Lang String No zh

The language of the request and response. Valid values:

  • zh: Chinese
  • en: English
Name String No data

The keyword used to search for the instance. SDDP searches for instances based on the keyword that you enter in fuzzy match mode.

PageSize Integer No 10

The number of entries to return on each page.
ProductCode String No RDS

The name of the service to which the instance belongs. Valid values:

  • MaxCompute
  • OSS
  • RDS
ProductId Long No 1

The ID of the service to which the instance belongs.

Note You can call the DescribeDataAssets operation to query the service ID.
RiskLevelId Long No 2

The risk level ID of the instance. Valid values:

  • 1: S1, indicating the low risk level
  • 2: S2, indicating the medium risk level
  • 3: S3, indicating the high risk level
  • 4: S4, indicating the highest risk level
RuleId Long No 333333

The ID of the sensitive data detection rule that the instance hits.

Note You can call the DescribeRules operation to query the ID of the sensitive data detection rule.

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.
Items

The list of instances that were queried.
Acl String acl

The access control list (ACL) that controls the access permissions of the OSS bucket.
CreationTime Long 1536751124000

The time when the instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

DepartName String ***DemoCenter

The name of the department to which the instance belongs.
Id Long 268

The unique ID of the instance.
Labelsec Integer 0

The security status of the MaxCompute data asset.
Name String gxdata

The name of the instance.
OdpsRiskLevelName String Medium risk level

The risk level of the MaxCompute data asset.
Owner String dtdep-239-******

The account that owns the instance.
ProductCode String RDS

The name of the service to which the instance belongs. Valid values:

  • MaxCompute
  • OSS
  • RDS
ProductId String 5

The ID of the service to which the instance belongs.
Protection Boolean false

Indicates whether the MaxCompute data asset is being protected. Valid values:

  • true: The MaxCompute asset is being protected.
  • false: The MaxCompute asset is not protected.
RiskLevelId Long 4

The risk level ID of the instance.
RiskLevelName String Highest risk level

The risk level of the instance.
RuleName String *** rule

The name of the sensitive data detection rule that the instance hits.
Sensitive Boolean true

Indicates whether the instance contains sensitive data. Valid values:

  • true: The instance contains sensitive data.
  • false: The instance does not contain sensitive data.
SensitiveCount Integer 123

The total volume of sensitive data in the instance. For example, the value can be the total number of sensitive MaxCompute projects or packages, the total number of sensitive RDS databases, or the total number of sensitive OSS buckets.

TotalCount Integer 231

The total volume of data in the instance. For example, the value can be the total number of MaxCompute projects or packages, the total number of RDS databases, or the total number of OSS buckets.

PageSize Integer 10

The number of entries returned per page.
RequestId String 71064826-726F-4ADA-B879-05D8055476FB

The ID of the request.
TotalCount Integer 12

The total number of returned entries.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeInstances
&<Common request parameters>

Sample success responses

XML format 

<DescribeInstances>
	  <RequestId>71064826-726F-4ADA-B879-05D8055476FB</RequestId>
	  <TotalCount>4</TotalCount>
	  <PageSize>10</PageSize>
	  <CurrentPage>1</CurrentPage>
	  <Items>
		    <Owner>dtdep-239-******</Owner>
		    <ProductCode>RDS</ProductCode>
		    <ProductId>1</ProductId>
		    <Acl></Acl>
		    <RiskLevelId>4</RiskLevelId>
		    <RiskLevelName>Highest risk level</RiskLevelName>
		    <DepartName>***DemoCenter</DepartName>
		    <Name>gxdata</Name>
		    <Labelsec>false</Labelsec>
		    <CreationTime>1536751124000</CreationTime>
		    <Sensitive>true</Sensitive>
		    <Id>268</Id>
		    <Protection>false</Protection>
	  </Items>
</DescribeInstances>

JSON format 

{
	"Items":[
		{
			"Owner":"dtdep-239-******",
			"Sensitive":true,
			"ProductCode":"RDS",
			"RiskLevelId":4,
			"DepartName":"***DemoCenter",
			"Protection":false,
			"ProductId":1,
			"Name":"gxdata",
			"CreationTime":1536751124000,
			"RiskLevelName":"Highest risk level",
			"Labelsec":false,
			"Id":268,
			"Acl":""
		}
	],
	"TotalCount":4,
	"PageSize":10,
	"RequestId":"71064826-726F-4ADA-B879-05D8055476FB",
	"CurrentPage":1
}

Error codes

For a list of error codes, visit the API Error Center.