All Products
Search

This Product

    DataWorks:DsgQuerySensResult

    Document Center

    DataWorks:DsgQuerySensResult

    Last Updated:Nov 21, 2024

    Queries the identification results of sensitive data.

    Operation description

    The query capability of the API operation is similar to the query feature in Data Security Guard in the DataWorks console. The API operation can be used to query the identification results of sensitive data of a tenant based on the association with the tenant ID.

    • You can search for a specific identification result based on filter conditions such as data source type and workspace.
    • You can sort the identification results of sensitive data of a tenant based on the values of a field in ascending or descending order.
    • This operation supports paged query.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    dataworks:DsgQuerySensResultlist
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TenantIdstringYes

    The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.

    		10241024
    DbTypestringNo

    The type of the database. Valid values:

    • ODPS.ODPS
    • HOLO.POSTGRES
    • EMR
    		ODPS.ODPS
    ProjectNamestringNo

    The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name.

    		project
    SchemaNamestringNo

    The name of the schema.

    		schema
    TablestringNo

    The name of the table.

    		table
    ColstringNo

    The name of the field.

    		col
    NodeNamestringNo

    The name of a data category.

    LevelstringNo

    The sensitivity level of the field.

    		3
    SensStatusstringNo

    The sensitivity status of the field.

    • 1: indicates sensitive.
    • -1: indicates non-sensitive.
    		1
    SensitiveIdstringNo

    The sensitive field ID.

    		10241024
    SensitiveNamestringNo

    The name of the sensitive field.

    OrderstringNo

    The sorting method.

    • DESC
    • ASC
    		DESC
    OrderFieldstringNo

    The field used for sorting.

    • gmt_create
    • gmt_modified
    		gmt_create
    PageNointegerNo

    The page number. Pages start from page 1.

    		1
    PageSizeintegerNo

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

    		10

    Response parameters

    ParameterTypeDescriptionExample
    object

    The data returned.

    Successboolean

    Indicates whether the request was successful.

    • true
    • false
    		true
    ErrorCodestring

    The error code.

    		400
    ErrorMessagestring

    The error message.

    HttpStatusCodeinteger

    The HTTP status code.

    		400
    Dataany

    The data returned.

    		1234
    RequestIdstring

    The request ID.

    		900000001
    DynamicErrorCodestring

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

    		400
    DynamicErrorMessagestring

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400BADPARAMETERSParameters are missing or in the wrong format.

    For a list of error codes, visit the Service error codes.