Obtain USMC Migration Plan - ListUSMCPlan

Overview

Obtain USMC Migration Plan

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUSMCPlan`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	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	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[ListPlanItem]	[]ListPlanItem	Yes

Data Model

ListPlanItem

Field Name	Type	Description Information	Required
PlanId	string	Migration Plan ID	No
Name	string	Name	No
SourceVendor	string	Migration Source	No
SourceRegion	string	Migration Source Region	No
TargetRegion	string	Migrate Target Region	No
NetworkType	int	Network Type, 10: Public Network, 20: Private Network, 30: Dedicated Line	No
AgentDownloadUrl	string	Client Download Address	No
CreateTime	int	Creation Time	No

Example

Request Example

https://api.surfercloud.com/?Action=ListUSMCPlan
&PlanId=NTbVurgb
&Offset=LAXVrJkb
&Limit=pdkNUQvA

Response Example

{
  "Action": "ListUSMCPlanResponse",
  "Data": [
    {
      "AgentDownloadUrl": "jSdNWvqa",
      "CreateTime": 4,
      "Id": "QhPxRTiO",
      "Name": "dKcNkBwb",
      "NetWorkType": 2,
      "Source": "PnAACDVz",
      "SourceRegion": "XFajGCiY",
      "TargetRegion": "lvrBfwZI"
    }
  ],
  "Message": "SdLiVRxr",
  "RetCode": 0
}

ListUSMCAgent ListUSMCTask