查看服务状态 - GetUDTSTaskStatus

简介

查看服务状态

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `GetUDTSTaskStatus`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	No
TaskId	string	任务ID	Yes
Type	string	任务类型，值为 transfer 或 integration， transfer 时任务为数据迁移，integration 时任务为数据集成。	No

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
Data	StatusData	StatusData	No

数据模型

StatusData

字段名	类型	描述信息	必填
MaxRetryCount	int	用户设置的最大失败重试次数	No
Status	string	任务状态, 状态有 Created:已创建,Checking:检查中,Dumping:转储中,Loading:加载中,Syncing:同步中,Synced:已同步,Done:完成,Failed:失败,Stopping:停止中,Stopped:停止,RetryPending:重试等待中,Starting:启动中,FailedUnrecoverable:异常,StoppedUnrecoverable:异常,Success:成功,Started:已启动	No
FailedMessage	string	当Status为Failed时, 显示失败原因	No
CurRetryCount	int	当前失败重试次数	No
Progress	Progress	Progress 全量迁移进度信息，当类型为增量迁移时为空	No
Sync	SyncData	Binlog 信息	No

Progress

字段名	类型	描述信息	必填
TotalCount	int	总条目数	No
CurCount	int	已迁移条目数	No
TotalDuration	int	估算总耗时间（单位秒）	No
CurDuration	int	已耗时间（单位秒）	No
Percentage	float	完成进度	No
RedisOffsetSize	int	Redis偏移量	No
RedisDelayTime	int	Redis延迟时间单位为秒	No
MongoDelayTime	int	Mongo延迟时间，单位为秒	No

SyncData

字段名	类型	描述信息	必填
BinlogName	string	Binlog 文件名，长度不超过128字符	No
BinlogPos	int	Binlog Pos	No
BinlogGTID	string	GTID	No

示例

请求示例


https://api.netlake.cn/?Action=GetUDTSTaskStatus
&ProjectId=org-hiny12
&TaskId=udts-ixdp441
&Type=YJymvzTG

响应示例


{
  "Action": "GetUDTSTaskStatusResponse",
  "Data": {
    "CurRetryCount": 0,
    "MaxRetryCount": 0,
    "Progress": {
      "CurCount": 0,
      "CurDuration": 0,
      "Percentage": 0,
      "TotalCount": 0,
      "TotalDuration": 0
    },
    "Status": "Done",
    "Sync": {
      "BinlogName": "mysql-bin.000006",
      "BinlogPos": 154
    }
  },
  "Message": "",
  "RetCode": 0
}