Updated on 2026-09-07 GMT+08:00

Modifying Column Information (Column Mapping and Column Filtering) of an Object - ModifyColumnInfos

Function

This API is used to modify 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

POST /v5/{project_id}/job/{job_id}/column-info-modification

**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
column_map_infos	Yes	Array of objects	Column information. For details, see ColumnMappingInfo.

**Table 4** ColumnMappingInfo
Parameter	Mandatory	Type	Description
object_id	Yes	String	Object ID.
column_info_lists	Yes	Array of objects	Column information. For details, see ColumnInfo.

**Table 5** ColumnInfo
Parameter	Mandatory	Type	Description
column_name	Yes	String	Column name.
column_type	No	String	Column type.
key_type	No	String	Key type of the column.
column_mapped_name	No	String	Name of the mapped column. The name must be unique.
status	No	Boolean	Whether to filter the column. If the column is a primary key column or unique key column, it cannot be filtered.
partition	No	Boolean	Whether to specify partitionKey for the column.
desensitization_algorithm	No	String	Column masking type. Supported versions: kernel version 26.4.0 or later Supported scenarios: Currently, this parameter is only available for MySQL to MySQL synchronization, Oracle to GaussDB Centralized synchronization, and Oracle to GaussDB Distributed synchronization. In addition, primary keys and unique keys cannot be masked. Value range: NAME: The middle part of a name is masked. PHONE: The middle part of a phone number is masked. IDENTITY_CARD: The middle part of an ID card number is masked. BANK_CARD: The middle part of a bank card number is masked. EMAIL: The prefix of an email address, except the first letter, is masked. ADDRESS: The suffix of an address is masked. DATE: Only the year is retained, and the date is replaced with 01-01. NUMERIC: A number is replaced with 0. SECRET_CONTENT: A large segment of text is replaced.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
modify_result	Boolean	Modification result.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Modifying the column information of an object

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

{
  "column_map_infos" : [ {
    "column_info_lists" : [ {
      "status" : true,
      "partition" : false,
      "column_name" : "id1",
      "column_type" : "int(11)",
      "key_type" : "PRI",
      "column_mapped_name" : "id1-new"
    }, {
      "status" : true,
      "partition" : false,
      "column_name" : "id2",
      "column_type" : "int(11)",
      "key_type" : "",
      "column_mapped_name" : ""
    } ],
    "object_id" : "db1-*-*-tt1"
  } ]
}

Example Responses

Status code: 200

{
  "modify_result" : true
}

Status code: 400

Bad Request

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

Status Code

Status Code	Description
200	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Database Object Configuration