You need to enable JavaScript to run this app.
导航
DescribeValidationTasks
最近更新时间:2024.12.31 11:00:39首次发布时间:2024.12.31 11:00:39

调用 DescribeValidationTasks 接口查询数据校验任务。

请求类型

同步请求。

请求参数

参数类型是否必选示例值描述
TaskTypeStringDataMigration任务类型。查询数据校验任务的参数取值为 DataValidation
PageNumberInteger1页码。取值范围 1~1000,默认值为 1。
PageSizeInteger10每页记录数。取值范围 1~1000,默认值为 10。

StartTime

Integer

1733822723214

数据校验任务开始时间,使用毫秒时间戳格式。

说明

  • 若设置了该参数,查询结束时间(即 EndTime)参数也必填。

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

EndTime

Integer

1733822812635

数据校验任务结束时间,使用毫秒时间戳格式。

说明

  • 若设置了该参数,查询结束时间(即 EndTime)参数也必填。

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

TaskStatus

String

Terminating

任务状态,取值如下:

  • Canceled:表示任务已取消。

  • Failed:表示任务执行失败。

  • Running:表示任务执行中。

  • Suspend:表示任务暂停中。

  • Init:表示任务待启动。

  • Terminating:表示任务终止中。

  • Succeed:表示任务执行成功。

NameStringdts-u04kluhkkt数据校验任务名称。

Ids

Array of String

[b2b9cf8568d349c3969d37494b******]

任务 ID 的列表。

ParentTaskIDString4f85ae2481a643d99c0f45444******迁移或同步任务 ID。

ValidationStatus

String

HasDiff

校验任务状态,取值如下:

  • HasDiff:表示数据不一致。

  • NoDiff:表示数据一致。

TaskSubType

String

FullRowCompare

数据校验任务类型,取值如下:

  • FullRowCompare:表示全量内容校验。

  • FullRowCountCompare:表示全量行数校验。

  • FullPkCompare:表示全量主键校验。

  • MetaCompare:表示结构校验。

  • IncrDataValidation:表示增量校验。

SrcEndpointType

String

Volc_MySQL

实例的接入方式,取值如下:

  • Volc_MySQL:表示火山引擎版 MySQL。

  • Volc_veDB_MySQL:表示火山引擎版 veDB MySQL。

  • Volc_PostgreSQL:表示火山引擎版 PostgreSQL。

  • Volc_Mongo:表示火山引擎版 MongoDB。

  • Public_MySQL:表示公网自建 MySQL。

  • Public_PostgreSQL:表示公网自建 PostgreSQL。

  • Public_Mongo:表示公网自建 MongoDB。

  • Express_MySQL:表示专有网络 MySQL。

  • Express_PostgreSQL:表示专有网络 PostgreSQL。

  • Express_Mongo:表示专有网络 MongoDB。

DestEndpointType

String

Volc_MySQL

实例的接入方式,取值如下:

  • Volc_MySQL:表示火山引擎版 MySQL。

  • Volc_veDB_MySQL:表示火山引擎版 veDB MySQL。

  • Volc_PostgreSQL:表示火山引擎版 PostgreSQL。

  • Volc_Mongo:表示火山引擎版 MongoDB。

  • Public_MySQL:表示公网自建 MySQL。

  • Public_PostgreSQL:表示公网自建 PostgreSQL。

  • Public_Mongo:表示公网自建 MongoDB。

  • Express_MySQL:表示专有网络 MySQL。

  • Express_PostgreSQL:表示专有网络 PostgreSQL。

  • Express_Mongo:表示专有网络 MongoDB。

返回参数

参数类型示例值描述
TotalInteger1校验任务数量。

Tasks

Object

[
    {
        "AddSyncObjectAllowed": true,
        "ChargeConfig": {
            "ChargeType": "PostPaid",
            "DestRegion": "cn-beijing",
            "DestType": "Volc_Mongo",
            "EnableV2": true,
            "SrcRegion": "cn-beijing",
            "SrcType": "Volc_Mongo",
            "TaskType": "DataValidation",
            "Times": 1,
            "TrafficSpec": "Compact"
        },
        "ChargeDetail": {
            "ChargeEndTime": 7258089600000,
            "ChargeStartTime": 1733973839000,
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "OrderNo": ""
        },
        "CreateTime": 1733973825755,
        "DestConfig": {
            "Category": "MongoDB",
            "CreateTime": 1733973825741,
            "DataSourceId": "1867036707258413057",
            "EndpointType": "Volc_Mongo",
            "ModifyTime": 1733973841654,
            "VolcMongoSettings": {
                "DBInstanceId": "mongo-replica-d91799021291",
                "DBInstanceName": "",
                "DeployType": "ReplicaSet",
                "MongoAuthSourceDB": "admin",
                "Password": "******",
                "RegionSettings": {
                    "Region": "cn-beijing"
                },
                "Username": "root"
            }
        },
        "EnableCloudMonitor": true,
        "EndTime": 0,
        "ParentTaskID": "4c1d32fe38c64ec7bf7f02d87926e94d",
        "ParentTaskName": "dts-483oh5l2ne",
        "ProgressSummary": {
            "Infos": null
        },
        "ProjectName": "default",
        "SrcConfig": {
            "Category": "MongoDB",
            "CreateTime": 1733973825740,
            "DataSourceId": "1867036707258413056",
            "EndpointType": "Volc_Mongo",
            "ModifyTime": 1733973840858,
            "VolcMongoSettings": {
                "DBInstanceId": "mongo-replica-386df9f4fd7c",
                "DBInstanceName": "",
                "DeployType": "ReplicaSet",
                "MongoAuthSourceDB": "admin",
                "Password": "******",
                "RegionSettings": {
                    "Region": "cn-beijing"
                },
                "Username": "root"
            }
        },
        "StartTime": 1733973840165,
        "TaskId": "b2b9cf8568d349c3969d37494b85e14d",
        "TaskName": "dts-u04kluhkkt",
        "TaskStatus": "Suspend",
        "TaskSubType": "IncrDataValidation",
        "TaskType": "DataValidation",
        "TenantId": "2100000746",
        "TrafficSpec": "Compact",
        "ValidationResultSummary": {
            "TaskSubType": "IncrDataValidation",
            "ValidationProgress": {
                "CompletePercentage": 0,
                "DestDelay": 101,
                "SrcDelay": 96
            }
        }
    }
]

数据校验详情。更多信息,请参见 TaskInfo

请求示例

POST /?Action=DescribeValidationTasks&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": "DataValidation",
    "PageNumber": 1,
    "PageSize": 10,
    "TaskSubType": "FullPkCompare"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202412121656512315ADFB6FDD8EDC5D6C-ca5e3f",
        "Action": "DescribeValidationTasks",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "Tasks": [
            {
                "AddSyncObjectAllowed": true,
                "ChargeConfig": {
                    "ChargeType": "PostPaid",
                    "DestRegion": "cn-beijing",
                    "DestType": "Volc_Mongo",
                    "EnableV2": true,
                    "SrcRegion": "cn-beijing",
                    "SrcType": "Volc_Mongo",
                    "TaskType": "DataValidation",
                    "Times": 1,
                    "TrafficSpec": "Compact"
                },
                "ChargeDetail": {
                    "ChargeEndTime": 7258089600000,
                    "ChargeStartTime": 1733973839000,
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid",
                    "OrderNo": ""
                },
                "CreateTime": 1733973825755,
                "DestConfig": {
                    "Category": "MongoDB",
                    "CreateTime": 1733973825741,
                    "DataSourceId": "1867036707258413057",
                    "EndpointType": "Volc_Mongo",
                    "ModifyTime": 1733973841654,
                    "VolcMongoSettings": {
                        "DBInstanceId": "mongo-replica-d91799021291",
                        "DBInstanceName": "",
                        "DeployType": "ReplicaSet",
                        "MongoAuthSourceDB": "admin",
                        "Password": "******",
                        "RegionSettings": {
                            "Region": "cn-beijing"
                        },
                        "Username": "root"
                    }
                },
                "EnableCloudMonitor": true,
                "EndTime": 0,
                "ParentTaskID": "4c1d32fe38c64ec7bf7f02d87926e94d",
                "ParentTaskName": "dts-483oh5l2ne",
                "ProgressSummary": {
                    "Infos": null
                },
                "ProjectName": "default",
                "SrcConfig": {
                    "Category": "MongoDB",
                    "CreateTime": 1733973825740,
                    "DataSourceId": "1867036707258413056",
                    "EndpointType": "Volc_Mongo",
                    "ModifyTime": 1733973840858,
                    "VolcMongoSettings": {
                        "DBInstanceId": "mongo-replica-386df9f4fd7c",
                        "DBInstanceName": "",
                        "DeployType": "ReplicaSet",
                        "MongoAuthSourceDB": "admin",
                        "Password": "******",
                        "RegionSettings": {
                            "Region": "cn-beijing"
                        },
                        "Username": "root"
                    }
                },
                "StartTime": 1733973840165,
                "TaskId": "b2b9cf8568d349c3969d37494b85e14d",
                "TaskName": "dts-u04kluhkkt",
                "TaskStatus": "Suspend",
                "TaskSubType": "IncrDataValidation",
                "TaskType": "DataValidation",
                "TenantId": "2100000746",
                "TrafficSpec": "Compact",
                "ValidationResultSummary": {
                    "TaskSubType": "IncrDataValidation",
                    "ValidationProgress": {
                        "CompletePercentage": 0,
                        "DestDelay": 101,
                        "SrcDelay": 96
                    }
                }
            }
        ],
        "Total": 1
    }
}

错误码

更多详情,请参见错误码