Get USMC task list - ListUSMCTask
Overview
Get USMC task list
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListUSMCTask . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
PlanId | string | Migration Plan ID | Yes |
Offset | string | List start position offset, default is 0 | No |
Limit | string | Return data length, default is 20, maximum 100 | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Data | array[ListTaskItem] | []ListTaskItem | Yes |
Data Model
ListTaskItem
Field Name | Type | Description Information | Required |
---|---|---|---|
SrcHostName | string | Source Machine Name | No |
SrcHostIp | string | Source Machine IP | No |
HostId | string | Target Machine ID | No |
HostIp | string | Target Machine IP | No |
TaskId | string | Task ID | No |
Name | string | Task Name | No |
AgentId | string | Client ID | No |
AgentName | string | Client Name | No |
State | string | Task Status | No |
AgentState | string | Client Status | No |
Progress | ProgressData | Task Progress | No |
MinimalCpuPlatform | string | CPU Platform | No |
MachineType | string | Machine Type | No |
CreateTime | int | Creation Time | No |
DiskType | string | Disk Type | No |
DataDiskType | string | Data Disk Type | No |
Gpu | int | Number of GPUs | No |
GpuType | string | GPU Type | No |
Cpu | int | CPU Cores | No |
Memory | int | Memory Size | No |
UDSetId | string | [Private Zone Properties] Zone ID | No |
UDHostId | string | [Private Zone Property] Host ID of the zone | No |
HostBinding | boolean | [UDSet Attributes] Enable the residence association attribute for the UDSet UHost. | No |
SecGroupId | array[SecGroup] | []SecGroup | No |
ProgressData
Field Name | Type | Description Information | Required |
---|---|---|---|
Percentage | float | Progress Percentage | No |
SecGroup
Field Name | Type | Description Information | Required |
---|---|---|---|
Id | string | Security Group ID | No |
Priority | int | Security Group Priority | No |
Example
Request Example
https://api.dezai.com/?Action=ListUSMCTask
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=XgqnRSEC
&Offset=7
&Limit=5
&SetId=WdlAPLrt
&NetworkId=xrqzmAQh
Response Example
{
"Action": "ListUSMCTaskResponse",
"Data": [
"jdbaCYcE"
],
"RetCode": 0
}