You can call this operation to query columns in MaxCompute or Relational Database Service (RDS) tables that you authorize Sensitive Data Discovery and Protection (SDDP) to access.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeColumns |
The operation that you want to perform. Set the value to DescribeColumns. |
CurrentPage | Integer | No | 1 |
The number of the page to return. |
InstanceId | Long | No | 2341234 |
The ID of the instance to which the column belongs. Note You can call the DescribeInstances operation to query the instance ID.
|
Lang | String | No | zh |
The language of the request and response. Valid values:
|
Name | String | No | test |
The keyword used to search for the column. SDDP searches for columns 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 | MaxCompute |
The name of the service to which the column belongs. Valid values:
|
RiskLevels | String | No | S2 |
The risk level ID of the column. Separate multiple IDs with commas (,). Valid values:
|
RuleId | Long | No | 11111 |
The unique ID of the sensitive data detection rule that the column hits. Note You can call the DescribeRules operation to query the ID of the sensitive data detection rule.
|
TableId | Long | No | 11132334 |
The unique ID of the MaxCompute or RDS table to which the column belongs. Note You can call the DescribeTables operation to query the table ID.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CurrentPage | Integer | 1 |
The page number of the returned page. |
Items |
The list of columns that were queried. |
||
CreationTime | Long | 1536751124000 |
The time when the column 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 | String |
The data type of the column. |
Id | Long | 268 |
The unique ID of the column. |
InstanceId | Long | 1436009 |
The ID of the instance to which the column belongs. |
Name | String | gxdata |
The name of the column. |
OdpsRiskLevelName | String | S3 |
The risk level of the column in the MaxCompute table. Valid values:
|
OdpsRiskLevelValue | Integer | 3 |
The risk level ID of the column in the MaxCompute table. Valid values:
|
ProductCode | String | MaxCompute |
The name of the service to which the column belongs. Valid values:
|
RiskLevelId | Long | 2 |
The risk level ID of the column. Valid values:
|
RiskLevelName | String | S2 |
The risk level of the column. Valid values:
|
RuleId | Long | 1 |
The ID of the sensitive data detection rule that the column hits. |
RuleName | String | ** rule |
The name of the sensitive data detection rule that the column hits. |
Sensitive | Boolean | false |
Indicates whether the column contains sensitive data. Valid values:
|
TableId | Long | 123 |
The ID of the MaxCompute or RDS table to which the column belongs. |
PageSize | Integer | 10 |
The number of entries returned per page. |
RequestId | String | 769FB3C1-F4C9-4****** |
The ID of the request. |
TotalCount | Integer | 12 |
The total number of returned entries. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeColumns
&<Common request parameters>
Sample success responses
XML
format
<DescribeColumns>
<RequestId>769FB3C1-F4C9-4******</RequestId>
<TotalCount>4</TotalCount>
<PageSize>10</PageSize>
<CurrentPage>1</CurrentPage>
<Items>
<Owner>dtdep-239-***</Owner>
<ProductCode>RDS</ProductCode>
<RiskLevelId>2</RiskLevelId>
<RiskLevelName>S2</RiskLevelName>
<DepartName>***DemoCenter</DepartName>
<Name>gxdata</Name>
<CreationTime>1536751124000</CreationTime>
<Sensitive>true</Sensitive>
<Id>268</Id>
<RuleId>1</RuleId>
<RuleName>** rule</RuleName>
<InstanceId>1</InstanceId>
<TableId>123</TableId>
</Items>
</DescribeColumns>
JSON
format
{
"Items":[
{
"Owner":"dtdep-239-***",
"Sensitive":true,
"ProductCode":"RDS",
"InstanceId":1,
"RiskLevelId":2,
"DepartName":"***DemoCenter",
"RuleName":"** rule",
"Name":"gxdata",
"CreationTime":1536751124000,
"RiskLevelName":"S2",
"RuleId":1,
"Id":268,
"TableId":123
}
],
"TotalCount":4,
"PageSize":10,
"RequestId":"769FB3C1-F4C9-4******",
"CurrentPage":1
}
Error codes
For a list of error codes, visit the API Error Center.