1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
本接口（DescribePGUserMigration）用于查询目标环境指定 migration 详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePGUserMigration。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EnvId | 是 | String | 云开发环境ID 示例值：pg-ethan06-d9gzgavrt1f14772b |
| MigrationVersion | 是 | String | 版本号 参数格式：14位时间格式 入参限制：纯数字 示例值：20260526000000 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Version | String | 版本号 参数格式：纯数字，14位时间格式 示例值：20260526000000 |
| Name | String | 版本名 参数格式：只允许小写字母和下划线 示例值：test_init |
| Query | String | 要执行的migration sql 语句 示例值：CREATE TABLE IF NOT EXISTS public.test ( version BIGINT PRIMARY KEY, name TEXT NOT NULL); |
| Rollback | String | 回滚的sql 语句 示例值：DROP TABLE IF EXISTS public.test; |
| Checksum | String | migration query 语句的checksum值 由服务端自动生成，同版本 checksum 不一致会拒绝执行 示例值：eeaf0dd9391ba7829bd12b47482fab4a0e031a040f00cfb6eafc5c23b9fcf791 |
| Source | String | 用于标记调用来源 示例值：repair |
| CreatedBy | String | 用于标记该条migration由谁创建，目前默认调用的用户uin 示例值：100019231666 |
| CreatedAt | String | 该migration创建时间 示例值：2026-05-26T11:34:19+08:00 |
| AppliedAt | String | 该migration应用时间 示例值：2026-05-26T11:34:19+08:00 |
| DurationMs | Integer | 该migration执行耗时 单位：毫秒 示例值：153 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribePGUserMigration
查询指定migration详情
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePGUserMigration
<公共请求参数>
{
"EnvId": "pg-ethan06-d9gzgavrt1f14772b",
"MigrationVersion": "20260526000000"
}输出示例
{
"Response": {
"AppliedAt": "2026-05-26T11:34:19+08:00",
"Checksum": "eeaf0dd9391ba7829bd12b47482fab4a0e031a040f00cfb6eafc5c23b9fcf791",
"CreatedAt": "2026-05-26T11:34:19+08:00",
"CreatedBy": "100019231666",
"DurationMs": 0,
"Name": "test_init",
"Query": "CREATE TABLE IF NOT EXISTS public.test ( version BIGINT PRIMARY KEY, name TEXT NOT NULL);",
"Rollback": "",
"Source": "repair",
"Version": "20260526000000",
"RequestId": "f68be1af-9118-45de-a062-88c6bbc671e3"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.SYS_ERR | 系统内部异常。 |
| InvalidParameter.INVALID_PARAM | 请求参数错误。 |
