云开发 CloudBase 批量应用 Migrations

1. 接口描述

接口请求域名： tcb.tencentcloudapi.com 。

本接口（PushPGUserMigrations）用于批量应用Migrations。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：PushPGUserMigrations。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	云开发环境ID 示例值：pg-ethan06-d9gzgavrt1f14772b
Migrations.N	是	Array of MigrationInput	结构化 SQL migration 列表；每项包含 Query SQL 内容
LockTimeoutMs	否	Integer	等待获取数据库锁的最长时间单位：毫秒默认值：5000 示例值：5000
StatementTimeoutMs	否	Integer	单条 SQL 执行最长时间，超过后由 PostgreSQL 取消该语句单位：毫秒默认值：300000 示例值：300000
Source	否	String	标记请求来源示例值：cloudapi

3. 输出参数

参数名称	类型	描述
TaskId	String	任务ID 可通过DescribeTaskResult 接口查询进度示例值：task-1ef06db7
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

参数名称

类型

描述

TaskId

String

任务ID

可通过DescribeTaskResult 接口查询进度

示例值：task-1ef06db7

RequestId

String

唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 PushPGUserMigrations

应用migration

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PushPGUserMigrations
<公共请求参数>

{
    "EnvId": "pg-ethan06-d9gzgavrt1f14772b",
    "Migrations": [
        {
            "Version": "20260526000000",
            "Name": "test_init",
            "Query": "CREATE TABLE IF NOT EXISTS public.test ( version BIGINT PRIMARY KEY, name TEXT NOT NULL);",
            "Rollback": "DROP TABLE IF EXISTS public.test;"
        }
    ],
    "LockTimeoutMs": 5000,
    "StatementTimeoutMs": 300000,
    "Source": "cloudapi"
}

输出示例

{
    "Response": {
        "TaskId": "task-1ef06db7",
        "RequestId": "9e40cb4d-ce83-442d-97f2-abdf65c0c58f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.SYS_ERR	系统内部异常。
InvalidParameter.INVALID_PARAM	请求参数错误。

批量应用 Migrations

本页目录：