DsgQuerySensResult

更新时间:
复制 MD 格式

Retrieves the sensitive data identification results from Data Security Guard.

Operation description

This API operation corresponds to the query feature on the Data Security Guard console interface. It retrieves the sensitive data identification results for a specified tenant by associating with the tenant ID.

  • Supports filtering by data source type, project workspace, and other dimensions.

  • Supports ascending or descending sorting on a specific field.

  • Supports paged query.

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

dataworks:DsgQuerySensResult

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

TenantId

string

No

The tenant ID. Log on to the DataWorks console, go to the DataStudio page, click the username in the upper-right corner, and choose Menu > User Info to obtain the tenant ID.

10241024

DbType

string

No

The database type. Valid values:

  • ODPS.ODPS

  • HOLO.POSTGRES

  • EMR

ODPS.ODPS

ProjectName

string

No

The name of the DataWorks workspace. Log on to the DataWorks console and go to the workspace configuration page to obtain the workspace name.

project

SchemaName

string

No

The schema name.

schema

Table

string

No

The table name.

table

Col

string

No

The field name.

col

NodeName

string

No

The classification node name.

Personal information

Level

string

No

The sensitivity level of the field.

3

SensStatus

string

No

The sensitivity status of the field. Valid values:

  • sensitive: sensitive.

  • noIdentify: not identified.

  • noResult: no result.

1

SensitiveId

string

No

The ID of the sensitive field.

10241024

SensitiveName

string

No

The name of the sensitive field.

name

Order

string

No

The sort order. Valid values:

  • DESC: descending.

  • ASC: ascending.

DESC

OrderField

string

No

The field used for sorting. Valid values:

  • gmt_create

  • gmt_modified

gmt_create

PageNo

integer

No

The page number. Minimum value: 1.

1

PageSize

integer

No

The number of entries per page. Default value: 10. Maximum value: 20.

10

startDate

string

No

The query start time in the format of yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.

2026-05-19

endDate

string

No

The query end time in the format of yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.

2026-05-19

Response elements

Element

Type

Description

Example

object

The response data.

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: successful.

  • false: failed.

true

ErrorCode

string

The error code.

400

ErrorMessage

string

The error message.

Missing parameter

HttpStatusCode

integer

The HTTP status code.

400

Data

any

The returned data.

1234

RequestId

string

The request ID. It is a unique identifier for the request.

900000001

DynamicErrorCode

string

The error code. The value is the same as ErrorCode.

400

DynamicErrorMessage

string

The error message. The value is the same as ErrorMessage.

Missing parameter

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 400,
  "Data": "1234",
  "RequestId": "900000001",
  "DynamicErrorCode": "400",
  "DynamicErrorMessage": "Missing parameter"
}

Error codes

HTTP status code

Error code

Error message

Description

400 BADPARAMETERS Parameters are missing or in the wrong format.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.