文档首页/ 云数据库 TaurusDB/ API参考/ API/ 冷热分离/ 创建/回迁冷表 - SwitchColdTableStorage
更新时间：2026-11-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建/回迁冷表 - SwitchColdTableStorage

功能介绍

对指定实例执行创建/回迁冷表操作。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:coldTable:operate

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:coldTable:operate

    -

URI

POST /v3/{project_id}/instances/{instance_id}/cold-tables/actions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英文。

  • zh-cn：中文。

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

参数解释：

操作类型。

约束限制：

不涉及。

取值范围：

  • archive：创建冷表。

  • unarchive：回迁冷表。

默认取值：

不涉及。

tables

是

Array of TableTarget objects

参数解释：

需要操作的表信息。

约束限制：

数组长度小于等于50。
表4 TableTarget

参数

是否必选

参数类型

描述

db_name

是

String

参数解释：

数据库名。

获取方法请参见查询冷热分离可归档表信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

table_name

是

String

参数解释：

表名。

获取方法请参见查询冷热分离可归档表信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

partition_name

否

String

参数解释：

分区名。

获取方法请参见查询冷热分离可归档表信息。

约束限制：

如果指定表下存在分区，则该参数必填。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

操作结果。

取值范围：

  • SUCCESS：成功。

  • FAILED：失败。

failed_items

Array of FailedItem objects

参数解释：

校验失败的表信息。

当result取值为FAILED时，返回此参数。
表6 FailedItem

参数

参数类型

描述

db_name

String

参数解释：

数据库名。

取值范围：

不涉及。

table_name

String

参数解释：

表名。

取值范围：

不涉及。

partition_name

String

参数解释：

分区名。

取值范围：

不涉及。

reason

String

参数解释：

失败原因。

取值范围：

  • restricted：内核限制无法下发。

  • incorrect：库名、表名、分区名有误。

  • duplicate：该表正在进行其他操作（待归档、待回迁、归档中、回迁中、已归档、已回迁）。

状态码：400

表7 响应Body参数

参数

参数类型

描述

result

String

参数解释：

操作结果。

取值范围：

  • SUCCESS：成功。

  • FAILED：失败。

failed_items

Array of FailedItem objects

参数解释：

校验失败的表信息。

当result取值为FAILED时，返回此参数。
表8 FailedItem

参数

参数类型

描述

db_name

String

参数解释：

数据库名。

取值范围：

不涉及。

table_name

String

参数解释：

表名。

取值范围：

不涉及。

partition_name

String

参数解释：

分区名。

取值范围：

不涉及。

reason

String

参数解释：

失败原因。

取值范围：

  • restricted：内核限制无法下发。

  • incorrect：库名、表名、分区名有误。

  • duplicate：该表正在进行其他操作（待归档、待回迁、归档中、回迁中、已归档、已回迁）。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

归档db1库orders表的p202301分区与logs整表。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/cold-tables/actions

{
  "action" : "archive",
  "tables" : [ {
    "db_name" : "db1",
    "table_name" : "orders",
    "partition_name" : "p202301"
  }, {
    "db_name" : "db1",
    "table_name" : "logs",
    "partition_name" : ""
  } ]
}

响应示例

状态码：200

{
  "result" : "SUCCESS"
}

状态码：400

{
  "result" : "FAILED",
  "failed_items" : [ {
    "db_name" : "db1",
    "table_name" : "orders",
    "partition_name" : "p202301",
    "reason" : "restricted"
  }, {
    "db_name" : "db1",
    "table_name" : "notexist",
    "partition_name" : "",
    "reason" : "incorrect"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 冷热分离

相关文档