DsgRunSensIdentify -

Starts a sensitive data identification task in Data Security Guard.

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	DsgRunSensIdentify	The operation that you want to perform. Set the value to DsgRunSensIdentify.
TenantId	String	Yes	10241024	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.
EsMetaParams	Array	No		The parameters that you need to configure to scan specified metadata.
DbType	String	No	ODPS.ODPS	The type of the data source. Valid values: ODPS.ODPS EMR HOLO.POSTGRES
ClusterId	String	No	101010	The cluster ID. You can obtain the ID based on the data source you use.
ProjectName	String	No	1666676756691024	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.
SchemaName	String	No	default	The name of the schema.
TableName	String	No	table1	The name of the table.
TableNameList	Array of String	No	table1,table2	The names of tables.
User	String	No	xxx-uat	The username of the operator. We recommend that you enter the username of your Alibaba Cloud account.
InstanceId	Long	No	hgprecn-cn-9lb37k181024	The instance ID. You can obtain the ID based on the data source you use.

Response parameters

Parameter	Type	Example	Description
ErrorCode	String	9990030003	The error code.
ErrorMessage	String	A required parameter is not specified.	The error message.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
Data	Any	1000001	The ID of the generated sensitive data identification task. The value is of the INT 64 type.
HttpStatusCode	Integer	400	The HTTP status code.
RequestId	String	10000001	The request ID. You can locate logs and troubleshoot issues based on the ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgRunSensIdentify
&TenantId=10241024
&EsMetaParams=[{"DbType":"ODPS.ODPS","ClusterId":"101010","ProjectName":"1666676756691024","SchemaName":"default","TableName":"table1","TableNameList":["table1,table2"],"User":"xxx-uat"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgRunSensIdentifyResponse>
    <ErrorCode>9990030003</ErrorCode>
    <ErrorMessage>A required parameter is not specified.</ErrorMessage>
    <Success>true</Success>
    <Data>1000001</Data>
    <HttpStatusCode>400</HttpStatusCode>
    <RequestId>10000001</RequestId>
</DsgRunSensIdentifyResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ErrorCode" : "9990030003",
  "ErrorMessage": "A required parameter is not specified.",
  "Success" : true,
  "Data" : "1000001",
  "HttpStatusCode" : 400,
  "RequestId" : "10000001"
}

Error codes

HttpCode	Error code	Error message	Description
400	BADPARAMETERS	Parameters are missing or in the wrong format.	A required parameter is not specified.

For a list of error codes, see Service error codes.