Starting or Stopping a Data Masking Task
Function
This API is used to start or stop a data masking task.
URI
POST /v1/{project_id}/sdg/server/mask/dbs/templates/{template_id}/operation
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        Project ID  | 
     
| 
        template_id  | 
      
        Yes  | 
      
        String  | 
      
        Template ID  | 
     
Request Parameters
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        status  | 
      
        Yes  | 
      
        Integer  | 
      
        Masking task status  | 
     
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        msg  | 
      
        String  | 
      
        Returned message  | 
     
| 
        status  | 
      
        String  | 
      
        Return status, for example, '200', '400'.  | 
     
Status code: 400
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        Error Code  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Error Message  | 
     
Example Requests
Start a data masking task.
POST /v1/{project_id}/sdg/server/mask/dbs/templates/{template_id}/operation
{
  "status" : 1
}
 Example Responses
Status code: 200
Request sent
{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}
  Status code: 400
Invalid request
{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}
 Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        Request sent  | 
     
| 
        400  | 
      
        Invalid request  | 
     
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.