Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Database Object Configuration/ Deleting Column Information (Column Mapping and Column Filtering) of an Object - DeleteColumnInfos
Updated on 2026-03-17 GMT+08:00
View PDF
Share

Deleting Column Information (Column Mapping and Column Filtering) of an Object - DeleteColumnInfos

Function

This API is used to delete the column information (column mapping and column filtering) of an object.

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}/job/{job_id}/column-info

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

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.

X-Auth-Token

Yes

String

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.

After a response is returned, the value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

table_ids

Yes

Array of strings

ID of the table to which the column belongs.

schema_ids

Yes

Array of strings

ID of the schema to which the column belongs.

db_ids

Yes

Array of strings

ID of the database to which the column belongs.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

delete_result

Boolean

Deletion result.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Deleting the column information of an object

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/fc77e18b-21c8-4040-96b5-ae599d3jb201/column-info

{
  "table_ids" : [ "db__create_job_012-*-*-tb01__create_job_012" ],
  "db_ids" : [ ],
  "schema_ids" : [ ]
}

Example Responses

Status code: 200

OK

{
  "delete_result" : true
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.