查询在线DDL任务

1. 接口描述

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

查询Online DDL 任务详情

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询OnlineDDL任务详情

输入示例

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

{
    "InstanceId": "tdsqlshard-a2csrmsr",
    "FlowId": 1143769
}

输出示例

{
    "Response": {
        "DDLDetails": [
            {
                "Alter": "add column add_col1;",
                "BeginTime": "2025-01-16 16:26:15 +0800 CST",
                "DbName": "db_prod",
                "Desc": "Error Error altering new table `db_prod`.`_tbl_user_new`: DBD::mysql::db do failed: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '' at line 1 [for Statement \"ALTER TABLE `db_prod`.`_tbl_user_new` add column add_col1;\"] at ./pt-online-schema-change line 9121.\n",
                "ShardSerialId": "set_1734351063_1",
                "Stage": "before_alter_new_table",
                "Status": 1,
                "SwitchStatus": 0,
                "Table": "tbl_user"
            }
        ],
        "ErrorMessage": "Error Error altering new table `db_prod`.`_tbl_user_new`: DBD::mysql::db do failed: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '' at line 1 [for Statement \"ALTER TABLE `db_prod`.`_tbl_user_new` add column add_col1;\"] at ./pt-online-schema-change line 9121.\n",
        "Process": 100,
        "RequestId": "9524d8fa-8598-414a-a3a1-4134c9631ca2",
        "Status": 1
    }
}

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: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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