Docs
api
Server Migration Center(USMC)
GetUSMCTaskStatus

View Task Status - GetUSMCTaskStatus

Overview

View Task Status

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUSMCTaskStatus.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
PlanIdstringMigration Plan IDYes
TaskIdstringTask IDYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataTaskStatusTaskStatusYes

Data Model

TaskStatus

Field NameTypeDescription InformationRequired
ProgressProgressDataProgressNo
StatestringStatusNo
FailedMessagestringError MessageNo

ProgressData

Field NameTypeDescription InformationRequired
PercentagefloatProgress PercentageNo

Example

Request Example

https://api.dezai.com/?Action=GetUSMCTaskStatus
&ProjectId=shafqzkV
&TaskId=xWgrvsUz

Response Example

{
  "Action": "GetUSMCTaskStatusResponse",
  "Data": {},
  "Message": "bEoqNfyv",
  "RetCode": 0
}