Get the current user’s Agent list - ListUSMCAgent

Overview

Get the current user’s Agent list

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUSMCAgent`.	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
AgentIds	string	Agent ID, multiple IDs separated by commas	No
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[ListAgentItem]	[ ]ListAgentItem	Yes

Data Model

ListAgentItem

Field Name	Type	Description Information	Required
AgentId	string	Client ID	No
Name	string	Client Name	No
Status	string	Client Status	No
OsData	OSData	[]OSData	No
ResourceData	HostResourceData	HostResourceData	No
HostName	string	Host Name	No
Ip	string	IP Address	No
Mac	string	MAC Address	No
AgentVerion	string	Client Version Number	No
DiskItems	array[DiskItem]	DiskItem	No
NetworkType	int	Network Type, 10: Public Network, 20: Private Network, 30: Dedicated Line	No
TargetRegion	string	Target Region	No
TargetZone	string	Target Availability Zone	No
TargetVPCId	string	Target VPC ID	No
TargetSubnetId	string	Target Subnet ID	No
CreateTime	int	Creation Time	No

OSData

Field Name	Type	Description Information	Required
OsType	string	Operating System Type	No
ArchType	string	Operating System Architecture	No
PlatformType	string	Operating System Platform	No
LinuxVer	string	Linux version, only valid for Linux system	No
WinVer	string	Windows version number, only valid for Windows system	No
KernelVersion	string	Kernel Version Number	No

HostResourceData

Field Name	Type	Description Information	Required
CpuNums	int	CPU Cores	Yes
MemSize	int	Memory Size	Yes
MachineType	string	Machine Type	Yes

DiskItem

Field Name	Type	Description Information	Required
Size	int	Disk Capacity	No
IsBoot	boolean	Is it a system disk?	No
DiskType	string	Disk Type	No

Example

Request Example


https://api.sigcalcloud.com/?Action=ListUSMCAgent
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=EOjyHBuq
&Offset=4
&Limit=9
&Region=BfVjoVSf
&SetId=ZxmoUssh
&AgentIds=oClQQgPk
&AgentIds=tuoDzvuT
&Region=sVvGRkEd

Response Example


{
  "Action": "ListUSMCAgentResponse",
  "Data": {},
  "RetCode": 0
}