You need to enable JavaScript to run this app.
导航
数据库传输服务
  • 文档首页
    • /
  • 数据库传输服务

DescribeTransmissionTaskProgress

最近更新时间：2024.01.16 17:59:29

首次发布时间：2023.03.29 20:40:00

我的收藏

调用 DescribeTransmissionTaskProgress 接口查询传输任务进度。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
TaskIdString是4ddec6d036384248a25862fb17cb****任务 ID。

ProgressType

String

是

Account

任务类型。取值如下：

  • Account：表示用户迁移。在 TaskType 取值为 DataMigration 时，支持该取值。

  • Meta：表示结构迁移、库表结构订阅或结构初始化。

  • Full：表示全量迁移、全量订阅或全量初始化。

  • Incr：表示增量迁移、增量订阅或增量同步。

  • PostMeta：表示后置结构迁移。当 TaskType 取值为DataMigration 时，支持该取值。

PageNumberInteger否1页码。取值范围 1~1000，默认值为 1。
PageSizeInteger否10每页记录数。取值范围 1~1000，默认值为 10。

TransmissionState

String

否

Transmitting

任务传输状态。取值如下：

  • None：表示任务待启动。

  • Transmitting：表示任务传输中。

  • Completed：表示任务已完成。

  • Removed：表示任务传输失败。

ObjectType

String

否

Database

对象类型。取值如下：

  • Database：表示数据库。

  • Table：表示表格。

  • View：表示视图。

  • Column：表示列。

  • Function：表示函数。

  • Procedure：表示程序。

  • Trigger：表示触发器。

  • Type：表示类型。

  • Domain：表示域名。

  • Sequence：表示序列。

  • Rule：表示规则。

  • Operator：表示操作符。

  • Aggregate：表示聚合。

  • Extension：表示扩展。

  • Constraint：表示约束。

  • PostSequence：表示 PostgreSQL 的序列。当参数为 PostgreSQL 时，需配置此参数。

  • Schema：表示模式。

  • Event：表示事件。

  • DomainConstraint：表示域约束。

NameString否test***对象名称。

LatencyDesc

Bool

否

true

是否按照延迟降序排序。取值如下：

  • true：表示按照降序排序。

  • false：表示不按照降序排序。

TransferEstimateRowsDesc

Bool

否

false

是否按照传输预估传输行数降序排序。取值如下：

  • true：表示按照降序排序。

  • false：表示不按照降序排序。

返回参数

名称类型描述示例值

TaskProgress

TaskProgress

任务进度的详细信息。详细信息，请参见 TaskProgress。

{
    "FullProgress":[
        {
            "Database":{
                "DestObjName":"test****1",
                "ObjectType":"Database",
                "SrcObjName":"test****1"
            },
            "FinishTime":1679299572000,
            "Object":{
                "DestObjName":"i_log",
                "ObjectType":"Table",
                "SrcObjName":"i_log"
            },
            "RowAvgBytes":0,
            "ShardID":"",
            "StartTime":1679299572000,
            "State":"Completed",
            "TransferBytes":0,
            "TransferEstimateBytes":0,
            "TransferEstimateRows":0,
            "TransferRows":0
        }
    ],
    "ProgressType":"Full",
    "Total":10
}

请求示例

POST /?Action=DescribeTransmissionTaskProgress&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host:dts.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
     "TaskId": "af16a602e1134abdbb281864ca******",
     "ProgressType": "Full",
     "PageNumber": 1,
     "PageSize": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230320160648C9A57C0DA2D94117B1C5",
        "Action": "DescribeTransmissionTaskProgress",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "TaskProgress": {
            "FullProgress": [
                {
                    "Database": {
                        "DestObjName": "test****1",
                        "ObjectType": "Database",
                        "SrcObjName": "test****1"
                    },
                    "FinishTime": 1679299572000,
                    "Object": {
                        "DestObjName": "i_log",
                        "ObjectType": "Table",
                        "SrcObjName": "i_log"
                    },
                    "RowAvgBytes": 0,
                    "ShardID": "",
                    "StartTime": 1679299572000,
                    "State": "Completed",
                    "TransferBytes": 0,
                    "TransferEstimateBytes": 0,
                    "TransferEstimateRows": 0,
                    "TransferRows": 0
                }
            ],
            "ProgressType": "Full",
            "Total": 10
        }
    }
}

错误码

更多详情，请参见错误码。