You can call this operation to query the sensitive data detection results of data assets that you authorize Sensitive Data Discovery and Protection (SDDP) to access.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDataAssets |
The operation that you want to perform. Set the value to DescribeDataAssets. |
CurrentPage | Integer | No | 1 |
The number of the page to return. |
Lang | String | No | zh |
The language of the request and response. Valid values:
|
Name | String | No | test |
The keyword used to search for the data asset. SDDP searches for data assets based on the keyword that you enter in fuzzy match mode. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. |
RangeId | Integer | No | 1 |
The type of the data asset. Valid values:
|
RiskLevels | String | No | S1 |
The risk level ID of the data asset. Separate multiple IDs with commas (,). Valid values:
|
RuleId | Long | No | 11122200 |
The unique ID of the sensitive data detection rule that the data asset 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 data assets 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 data asset 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. |
DataType | String | OSS_BUCKET |
The data type of the data asset. |
Id | Long | 268 |
The unique ID of the data asset. |
Labelsec | Integer | 0 |
The security status of the MaxCompute data asset. |
Name | String | gxdata |
The name of the data asset that was queried. |
ObjectKey | String | Internal |
The key value of the OSS object. |
OdpsRiskLevelName | String | S4 |
The risk level of the MaxCompute data asset. Valid values:
|
Owner | String | dtdep-239-****** |
The account that owns the data asset. |
ProductCode | String | RDS |
The name of the service to which the data asset belongs. Valid values:
|
ProductId | String | 5 |
The ID of the service to which the data asset belongs. |
Protection | Boolean | false |
Indicates whether the MaxCompute data asset is being protected. |
RiskLevelId | Long | 2 |
The risk level ID of the data asset. |
RiskLevelName | String | Medium risk level |
The risk level of the data asset. |
RuleName | String | *** rule |
The name of the sensitive data detection rule that the data asset hits. |
Sensitive | Boolean | true |
Indicates whether the data asset contains sensitive data. Valid values:
|
SensitiveCount | Integer | 24 |
The total volume of sensitive data in all data assets. For example, the value can be the total number of sensitive MaxCompute projects, packages, or tables, the total number of sensitive RDS databases or tables, or the total number of sensitive OSS buckets or objects. |
SensitiveRatio | String | 45% |
The percentage of sensitive data in all data assets. |
TotalCount | Integer | 432 |
The total volume of data in all data assets. For example, the value can be the total number of MaxCompute projects, packages, or tables, the total number of RDS databases or tables, or the total number of OSS buckets or objects. |
PageSize | Integer | 10 |
The number of entries returned per page. |
RequestId | String | 71064826-726F-4ADA-B879-05D8055476FB |
The ID of the request. |
TotalCount | Integer | 20 |
The total number of returned entries. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeDataAssets
&RangeId=1
&CurrentPage=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
<DescribeDataAssets>
<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>5</ProductId>
<Acl></Acl>
<RiskLevelId>2</RiskLevelId>
<RiskLevelName>Medium risk level</RiskLevelName>
<DepartName>***DemoCenter</DepartName>
<Name>gxdata</Name>
<Labelsec>0</Labelsec>
<CreationTime>1536751124000</CreationTime>
<Sensitive>true</Sensitive>
<Id>268</Id>
<Protection>false</Protection>
<RuleName>*** rule</RuleName>
<ObjectKey>Internal</ObjectKey>
</Items>
</DescribeDataAssets>
JSON
format
{
"Items":[
{
"Owner":"dtdep-239-******",
"Sensitive":true,
"ProductCode":"RDS",
"RiskLevelId":2,
"DepartName":"***DemoCenter",
"ObjectKey":"Internal",
"Protection":false,
"RuleName":"*** rule",
"ProductId":5,
"Name":"gxdata",
"CreationTime":1536751124000,
"RiskLevelName":"Medium risk level",
"Labelsec":0,
"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.