You need to enable JavaScript to run this app.
导航
数据库传输服务
  • 文档首页
    • /数据库传输服务/API 参考/数据传输/DescribeTransmissionTasks
DescribeTransmissionTasks
最近更新时间：2025.04.03 10:40:04首次发布时间：2023.03.29 20:40:15
我的收藏
有用
有用
无用
无用

调用 DescribeTransmissionTasks 接口查看传输任务列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

TaskType

String

是

DataMigration

任务类型。取值如下：

  • DataMigration：表示查看数据迁移任务。

  • DataSubscription：表示查看数据订阅任务。

  • DataSynchronization：表示查看数据同步任务。

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

StartTime

Integer

否

1679279179688

任务开始时间，使用毫秒时间戳格式。

说明

  • 若设置了该参数，查询结束时间（即 EndTime）参数也必填。

  • 若该参数留空，默认返回当前任务类型下已存在的所有任务。

EndTime

Integer

否

1679279179699

任务结束时间，使用毫秒时间戳格式。

说明

  • 若设置了该参数，查询结束时间（即 EndTime）参数也必填。

  • 结束时间要晚于开始时间。

TaskStatus

String

否

Terminating

任务状态，取值如下：

  • Success：表示传输已完成。

  • Failed：表示传输任务执行失败。

  • Running：表示传输任务执行中。

  • Suspend：表示传输任务暂停中。

  • Init：表示传输任务待启动。

  • Canceled：表示传输任务已取消。

  • Terminating：表示传输任务已终止。

Name

String

否

test****

任务名称。命名规则：

  • 以字母开头且不能为空。

  • 长度需在 64 个字符内。

  • 只能包含字母、数字、下划线（_）和中划线（-）。

IdsArray of String否78b65776a25d4970a1c82bd2f35****任务 ID 的列表。

ChargeType

String

否

PostPaid

计费类型，取值如下：

  • NotEnabled：表示未开启计费。

  • PostPaid：表示按量付费。

  • PrePaid：表示包年包月。

ProjectName

String

否

default

项目名称。

说明

您可以调用 CreateProject 接口创建项目。

返回参数

名称类型示例值描述
TotalInteger1任务总数量。

Tasks

Array of TaskInfo

[
    {
        "AddSyncObjectAllowed":true,
        "ChargeDetail":{
            "ChargeStatus":"Init",
            "ChargeType":"PostPaid",
            "OrderNo":""
        },
        "DestConfig":{
            "DataSourceId":"322",
            "EndpointType":"Volc_Kafka",
            "VolcKafkaSettings":{
                "AuthType":"PLAIN",
                "InstanceId":"kafka-cnngfsm7gl*******",
                "InstanceName":"",
                "Password":"******",
                "RegionSettings":{
                    "Region":""
                },
                "Topic":"hua",
                "Username":"kakatest****"
            }
        },
        "EnableCloudMonitor":true,
        "EnableDataValidation":false,
        "EndTime":0,
        "ProgressSummary":{
            "Infos":[
                {
                    "ErrorInfo":"",
                    "NameCN":"增量订阅",
                    "ProgressType":"Incr",
                    "Status":"Todo"
                }
            ]
        },
        "ProjectName":"default",
        "SrcConfig":{
            "DataSourceId":"321",
            "EndpointType":"Volc_PostgreSQL",
            "VolcPostgreSQLSettings":{
                "DBInstanceId":"postgres-338f4******",
                "DBInstanceName":"",
                "DBName":"test****zaizai",
                "Password":"******",
                "RegionSettings":{
                    "Region":"cn-beijing"
                },
                "Username":"test****zaizai"
            }
        },
        "StartTime":1661242976288,
        "TaskId":"c37008625ddd44019ee85b84fb8*****",
        "TaskName":"test****zaizai",
        "TaskStatus":"Init",
        "TaskSubType":"Default",
        "TaskType":"DataSubscription",
        "TenantId":"2100157781",
        "TrafficSpec":"Compact"
    }
]

任务列表。详细信息，请参见 TaskInfo。

请求示例

POST /?Action=DescribeTransmissionTasks&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****

{
     "TaskType": "DataSubscription",
     "PageNumber": 1,
     "PageSize":10
     
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202303201012545D1AD5D48733EB0D3AE8",
        "Action": "DescribeTransmissionTasks",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "Tasks": [
            {
                "AddSyncObjectAllowed": true,
                "ChargeDetail": {
                    "ChargeStatus": "Init",
                    "ChargeType": "PostPaid",
                    "OrderNo": ""
                },
                "DestConfig": {
                    "DataSourceId": "322",
                    "EndpointType": "Volc_Kafka",
                    "VolcKafkaSettings": {
                        "AuthType": "PLAIN",
                        "InstanceId": "kafka-cnngfsm7gl******",
                        "InstanceName": "",
                        "Password": "******",
                        "RegionSettings": {
                            "Region": ""
                        },
                        "Topic": "hua",
                        "Username": "kakatest****"
                    }
                },
                "EnableCloudMonitor": true,
                "EnableDataValidation": false,
                "EndTime": 0,
                "ProgressSummary": {
                    "Infos": [
                        {
                            "ErrorInfo": "",
                            "NameCN": "增量订阅",
                            "ProgressType": "Incr",
                            "Status": "Todo"
                        }
                    ]
                },
                "ProjectName": "default",
                "SrcConfig": {
                    "DataSourceId": "321",
                    "EndpointType": "Volc_PostgreSQL",
                    "VolcPostgreSQLSettings": {
                        "DBInstanceId": "postgres-338f4f******",
                        "DBInstanceName": "",
                        "DBName": "test****zaizai",
                        "Password": "******",
                        "RegionSettings": {
                            "Region": "cn-beijing"
                        },
                        "Username": "test****zaizai"
                    }
                },
                "StartTime": 1661242976288,
                "TaskId": "c37008625ddd44019ee85b84fb8*****",
                "TaskName": "test****zaizai",
                "TaskStatus": "Init",
                "TaskSubType": "Default",
                "TaskType": "DataSubscription",
                "TenantId": "2100157781",
                "TrafficSpec": "Compact"
            }
        ],
        "Total": 1
    }
}

错误码

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