文档首页/ 数据复制服务 DRS/ API参考/ API v5(公测中)/ 实例数据库对象配置/ 修改对象的列信息(列映射、列过滤) - ModifyColumnInfos
更新时间:2026-02-04 GMT+08:00
分享

修改对象的列信息(列映射、列过滤) - ModifyColumnInfos

功能介绍

修改对象的列信息(列映射、列过滤)

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。 获取方法请参见获取项目ID。

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

X-Auth-Token

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

枚举值:

  • en-us

  • zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

column_map_infos

Array of objects

列信息

详情请见表 ColumnMappingInfo

表4 ColumnMappingInfo

参数

是否必选

参数类型

描述

object_id

String

对象id

column_info_lists

Array of objects

列信息

详情请见表 ColumnInfo

表5 ColumnInfo

参数

是否必选

参数类型

描述

column_name

String

列名

column_type

String

列类型

key_type

String

列的键类型。

column_mapped_name

String

列映射后的名称

status

Boolean

该列是否过滤

partition

Boolean

该列是否partitionKey

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

modify_result

Boolean

修改结果

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

修改对象的列信息

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"
  } ]
}

响应示例

状态码:200

OK

{
  "modify_result" : true
}

状态码:400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档