Deleting Information About Data Filtering Rules
Function
This API is used to delete information about data filtering rules.
Constraints
Only unsynchronized data filtering rules can be deleted.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.
URI
DELETE /v5/{project_id}/jobs/{job_id}/filter-rules
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| job_id | Yes | String | Definition Data migration task ID, which is used to specify the target task for which filtering rules are to be deleted. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | No | String | Definition MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. Constraints N/A Range application/json Default Value application/json |
| X-Auth-Token | Yes | String | Definition User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A |
| X-Language | No | String | Definition Request language type. Constraints Specify the request language type based on the supported languages. Range
Default Value en-us |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| rule_ids | Yes | Array of longs | Definition List of IDs of data filtering rules to be deleted. Multiple rules can be deleted at a time. Constraints This parameter corresponds to the batch_id field in the response of the query API. Range N/A Default Value N/A |
| type | Yes | String | Definition Type of the data filtering criteria. Constraints N/A Range
Default Value N/A |
Response Parameters
Status code: 200
Response body for a deletion task.
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code returned when an error occurs during task execution. Constraints
Range The format is DRS.XXXXXX. |
| error_msg | String | Definition Detailed error description returned when a task fails to be executed. Constraints
Range N/A |
Example Request
Request body for deleting data filtering rules in batches
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/filter-rules
{
"rule_ids" : [ 1, 2 ],
"type" : "common"
} Example Response
Status code: 400
Bad Request
{
"error_code" : "DRS.10000001",
"error_msg" : "Failed."
} Error Code
For details, see Error Code.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot