Saasame Restful API Reference Document

Saasame Mgmt. API Reference

Setup Environment Prepare Workload Recover Workload

Last modified: January 28 2019 06:16:04

Cloud

Transport

Host

List Cloud

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtCloudConnection
Method: POST
Params:

{
	'Action'  : 'ListCloud',
	'AcctUUID': STRING
}

Response:

{
	'CLUSTER_UUID': STRING,
	'PROJECT_NAME': STRING,
	'CLUSTER_ADDR': STRING,
	'CLUSTER_USER': STRING,
	'TIMESTAMP'   : YYYY-MM-DD HH-MM-SS
	'CLOUD_TYPE'  : STRING,
	'VENDOR_TYPE' : STRING,
	'REGION_NAME' : STRING
}

Error:

{
	TBD
}

Delete Cloud

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtCloudConnection
Method: POST
Params:

{
	'Action'        : 'DeleteSelectCloud',
	'ClusterUUID': STRING
}

Response:

{
	'Code' : true|false,
	'Msg'  : STRING
}

Error:

{
	TBD
}

Verify OpenStack Connection

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /AddOpenStackConnection
Method: POST
Params:

{
	'Action'          : 'VerifyOpenStackConnection',
	'ProjectName'     : STRING,
	'ClusterUsername' : STRING,
	'ClusterPassword' : STRING,
	'IdentityProtocol': 'HTTP|HTTPS',
	'ClusterVipAddr'  : STRING,
	'IdentityPort'    : NUMBER
}

Response:

{
	true|false
}

Error:

{
	TBD
}

Initialize OpenStack Connection

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /AddOpenStackConnection
Method: POST
Params:

{
	'Action' 	      : 'InitializeNewOpenStackConnection',
	'AcctUUID'        : STRING,
	'RegnUUID'        : STRING,
	'ProjectName'     : STRING,
	'ProjectId'       : STRING,
	'ClusterUsername' : STRING,
	'ClusterPassword' : STRING,
	'IdentityProtocol': 'HTTP|HTTPS'
	'ClusterVipAddr'  : STRING,
	'IdentityPort'    : NUMBER,
	'EndpointRefAddr' : STRING
}

Response:

{
	'Code' : true|false
	'Msg'  : STRING
}

Error:

{
	TBD
}

Query OpenStack Credential Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /EditOpenStackConnection
Method: POST
Params:

{
	'Action'     : 'QueryAccessCredentialInformation',
	'ClusterUUID': STRING
}

Response:

{
	'ACCT_UUID'   : STRING, 
	'REGN_UUID'   : STRING,
	'CLUSTER_UUID': STRING,
	'PROJECT_NAME': STRING,
	'CLUSTER_USER': STRING,
	'CLUSTER_PASS': STRING,
	'CLUSTER_ADDR': STRING,
	'AUTH_TOKEN'  : STRING,
	'TIMESTAMP'   : YYYY-MM-DD HH-MM-SS
}

Error:

{
	TBD
}

Update OpenStack Cloud Connection

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /EditOpenStackConnection
Method: POST
Params:

{
	'Action'          : 'UpdateOpenStackConnection',
	'ClusterUUID'     : STRING,
	'ProjectName'     : STRING,
	'ProjectId'    	  : STRING,
	'ClusterUsername' : STRING,
	'ClusterPassword' : STRING,
	'IdentityProtocol': 'HTTP|HTTPS',
	'ClusterVipAddr'  : STRING,
	'IdentityPort'	  : NUMBER,
	'EndpointRefAddr' : STRING
}

Response:

{
	true|false
}

Error:

{
	TBD
}

Verify AWS Connection

Address: http://127.0.0.1:8080/restful/AmazonWebServices
UI Reference: /AddAwsConnection
Method: POST
Params:

{
	'Action'   : 'VerifyAwsAccessCredential',
	'AccessKey': STRING,
	'SecretKey': STRING
}

Response:

{
	true|false
}

Error:

{
	TBD
}

Initialize AWS Connection

Address: http://127.0.0.1:8080/restful/AmazonWebServices
UI Reference: /AddAwsConnection
Method: POST
Params:

{
	'Action'   : 'InitializeNewAwsConnection',
	'AcctUUID' : STRING,
	'RegnUUID' : STRING,
	'AccessKey': STRING,
	'SecretKey': STRING
}

Response:

{
	'Code' : true|false
	'Msg'  : STRING
}

Error:

{
	TBD
}

Query AWS Access Credential Information

Address: http://127.0.0.1:8080/restful/AmazonWebServices
UI Reference: /EditAwsConnection
Method: POST
Params:

{
	'Action'     : 'QueryAccessCredentialInformation',
	'ClusterUUID': STRING
}

Response:

{
	'ACCT_UUID'   : STRING, 
	'REGN_UUID'   : STRING,
	'CLUSTER_UUID': STRING,
	'PROJECT_NAME': AWS,
	'ACCESS_KEY'  : STRING,
	'SECRET_KEY'  : STRING,
	'DEFAULT_ADDR': None,
	'USER_UUID'   : STRING,
	'TIMESTAMP'   :YYYY-MM-DD HH-MM-SS
}

Error:

{
	TBD
}

Query Available Service

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtTransportConnection
Method: POST
Params:

{
	'Action'  : 'QueryAvailableService',
	'AcctUUID': STRING,
	'ServTYPE': STRING,
	'SystTYPE': STRING
}

Response:

{
	'ID'		: INTEGER,
	'ACCT_UUID'	: STRING,
	'REGN_UUID'	: STRING,
	'OPEN_UUID'	: STRING,
	'HOST_UUID'	: STRING,
	'HOST_REGN'	: 'REGION_TYPE',
	'HOST_TYPE'	: 'HOST_TYPE',
	'SERV_UUID'	: STRING,
	'HOST_NAME'	: STRING,
	'SERV_ADDR'	: ['IP_ADDRESS'],
	'SERV_LOCA'	: 'LOCATION_TYPE',
	'SERV_TYPE'	: 'Launcher',
	'LAUN_UUID'	: false
}

Error:

{
	TBD
}

Verify Service Connection

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /VerifyOnPremiseTransportServices
Method: POST
Params:

{
	'Action'	: 'VerifyServiceConnection',
	'ServADDR'	: STRING,
	'SeltSERV'	: 'Scheduler,Carrier,Loader,Launcher',
	'MgmtADDR'  : 'IP_ADDRESS'
}

Response:

{
	'Code'	: true|false,
	'Msg'	-> 
		'version' 	  : 'VERSION_STRING',
		'path' 		  : 'TRANSPORT_INSTALL_PATH',
		'architecture': STRING,
		.
		.
		.
		...etc.
}

Error:

{
	'Code'	: false
}

Verify Folder Connection

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /VerifyOnPremiseTransportServices
Method: POST
Params:

{
	'Action'	: 'VerifyFolderConnection',
	'ServADDR'	: STRING,
	'ConnDEST'	: 'INSTALL_PATH'+'\\imagex'
}

Response:

{
	'Code'	: true
}

Error:

{
	'Code'	: false
}

Initialize New Services

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /VerifyOnPremiseTransportServices
Method: POST
Params:

{
	'Action'	: 'InitializeNewServices',
	'AcctUUID'	: STRING,
	'RegnUUID'	: STRING,					
	'OpenUUID'	: 'OPENSTACK_CLOUD_UUID|ONPREMISE-00000-LOCK-00000-PREMISEON',
	'HostUUID'	: 'OPENSTACK_CLOUD_UUID|ONPREMISE-00000-LOCK-00000-PREMISEON',
	'ServADDR'	: 'TRANSPORT_ADDRESS'
	'SeltSERV'	: 'WINDOWS|LINUX',
	'SystTYPE'	: 'Scheduler,Carrier,Loader,Launcher',
	'MgmtADDR'	: 'MGMT_ADDRESS'
}

Response:

{
	'Code'	: true
}

Error:

{
	'Code'	: false
}

Initialize NewFolder Connection

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /VerifyOnPremiseTransportServices
Method: POST
Params:

{
	'Action'	 : 'InitializeNewFolderConnection',
	'AcctUUID'	 : STRING,
	'ServADDR'	 : 'TRANSPORT_ADDRESS',
	'ServUUID'	 : SERV.UUID,
	'ClusterUUID': 'CLOUD_UUID|ONPREMISE-00000-LOCK-00000-PREMISEON',
	'MgmtADDR' 	 : 'MGMT_ADDRESS',
	'ConnDEST' 	 : 'INSTALL_PATH'+'\\imagex'
}

Response:

{
	'Code'	: true
}

Error:

{
	'Code'	: false
}

Query Transport Server Information

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /EditOnPremiseTransportServices
Method: POST
Params:

{
	'Action'	 : 'QueryTransportServerInformation',
	'ServUUID'	 : STRING
}

Response:

{
	'ACCT_UUID': STRING,
	'REGN_UUID': STRING,
	'SERV_UUID': STRING,
	'OPEN_UUID': STRING,
	'OPEN_HOST': STRING,
	'HOST_NAME': STRING,
	'SERV_ADDR': ["TRANSPORT_ADDRESS"],
	'SERV_INFO': Object {id="{UUID_STRING}",  version="VERSION_STRING",  path="INSTALL_PATH",  more...},
	'SERV_MISC': Object {ADDR='ESX_ADDRESS',  USER='ESX_USERNAME',  PASS='ESX_PASSWORD'},
	'SERV_TYPE': STRING,
	'LIST_ADDR': Object {"TRANSPORT_ADDRESS"},
	'SYST_TYPE': 'WINDOWS|LINUX'
}

Error:

{
	'Code'	: false
}

Update Trnasport Services

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /EditOnPremiseTransportServices
Method: POST
Params:

{
	'Action'	: 'UpdateTrnasportServices',
	'ServUUID' 	: STRING,
	'ServADDR'	: 'TRANSPORT_ADDRESS'
}

Response:

{
	'Code'	: true
}

Error:

{
	'Code'	: false
}

List Installed Instances

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /SelectTransportInstance
Method: POST
Params:

{
	'Action'		:'ListInstalledInstances',
	'ClusterUUID'	:'CLOUD_CLUSTER_UUID'
}

Response:

{
	'servers'	:[Object
					{ status="ACTIVE", updated="YYYY-MM-DD HH:MM:SS", hostId="STRING",  more...}
				]
}

Error:

{
	'Code'	: false
}

Query Selected Host Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /VerifyCloudTransportServices
Method: POST
Params:

{
	'Action'		:'QuerySelectedHostInformation',
	'ClusterUUID'	:'CLOUD_CLUSTER_UUID',
	'HostUUID'		:'CLOUD_HOST_UUID'	
}

Response:

{
	'servers'	:[Object
					{ status="ACTIVE", updated="YYYY-MM-DD HH:MM:SS", hostId="STRING",  more...}
				]
}

Error:

{
	'Code'	: false
}

Query Available Host

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtHostConnection
Method: POST
Params:

{
	'Action'	: 'QueryAvailableHost',
	'AcctUUID'	: STRING,
	'ServTYPE'	: 'Physical Packer|Virtual Packer'
}

Response:

{
	"ID": ID,
	"ACCT_UUID": STRING,
	"REGN_UUID": STRING,
	"HOST_UUID": STRING,
	"HOST_NAME": STRING,
	"HOST_ADDR": 'IP_ADDRESS',
	"SERV_UUID": STRING,
	"OS_TYPE"  : 'WINDOWS|LINUX',
	"PACK_NAME": STRING,
	"PACK_ADDR": 'IP_ADDRESS',
	"SERV_MISC": '[Object {"architecture":"amd64", "client_id":STRING, "client_name":STRING, "domain":STRING, more...}]',
	"DISK_SIZE": BIG_INTEGER,
	"HOST_TYPE": 'Physical|Virtual',
	"PROTECTED": 'true|false'
}

Error:

{
	false
}

Delete Packer Host

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtHostConnection
Method: POST
Params:

{
	'Action'	: 'DeletePackerHost'
	'HostUUID'	: STRING
}

Response:

{
	NULL
}

Error:

{
	NULL
}

Reflush Packer

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtHostConnection
Method: POST
Params:

{
	'Action'	: 'ReflushPacker',
	'AcctUUID'	: STRING
}

Response:

{
	NULL
}

Error:

{
	NULL
}

Test Service Connection

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /VerifyHostPhysical
Method: POST
Params:

{
	'Action'	: 'TestServiceConnection',
	'ServADDR'	: 'SERVER_ADDRESS',
	'HostADDR'	: 'ESX_ADDRESS',
	'HostUSER'	: 'ESX_USERNAME',
	'HostPASS'	: 'ESX_PASSWORD',
	'HostUUID'	: 'SELECT_TRANSPORT_UUIT',
	'ServTYPE'	: 'Physical Packer|Virtual Packer|Offline Packer'
}

Response:

{
	'Code': true
}

Error:

{
	TBD
}

Initialize New Service

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /VerifyHostPhysical
Method: POST
Params:

{
	'Action'	: 'InitializeNewService',
	'AcctUUID'	: STRING,
	'RegnUUID'	: STRING,
	'OpenUUID'	: STRING,
	'HostUUID'	: STRING,
	'ServADDR'	: 'PACKER_ADDRESS',
	'HostADDR'	: 'ESX_ADDRESS',
	'HostUSER'	: 'ESX_USERNAME',
	'HostPASS'	: 'ESX_PASSWORD',
	'ServTYPE'	: 'Scheduler|Carrier|Loader|Launcher|ESX|null',
	'SystTYPE'	: 'Physical Packer|Virtual Packer|Offline Packer'
}

Response:

{
	'Code' : true|false
}

Error:

{
	TBD
}

Query Host Info

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /EditHostPhysical
Method: POST
Params:

{
	'Action'	: 'QueryHostInfo',
	'HostUUID'	: STRING
}

Response:

{
	'ACCT_UUID' : STRING,
	'REGN_UUID' : STRING,
	'HOST_UUID' : STRING,
	'HOST_NAME' : STRING,
	'HOST_ADDR' : 'HOST_ADDRESS',
	'HOST_DISK'	: [Object { HOST_UUID=STRING, DISK_UUID=STRING, DISK_NAME=STRING,  more...}],
	'HOST_INFO'	: Object { architecture=STRING, client_id=STRING, client_name=STRING,  more...},
	'HOST_SERV'	: Object { ACCT_UUID=STRING, REGN_UUID=STRING, SERV_UUID=STRING,  more...},
	'HOST_TYPE'	: 'Physical|Virtual'
}

Error:

{
	TBD
}

Update Host Information

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /EditHostPhysical
Method: POST
Params:

{
	'Action'	: 'UpdateHostInformation',
	'AcctUUID'	: STRING,
	'RegnUUID'	: STRING,
	'OpenUUID'	: STRING,
	'ServUUID'	: STRING,
	'ServADDR'	: 'SERVER_ADDRESS',
	'HostUUID'	: STRING,
	'HostADDR'	: 'ESX_ADDRESS',
	'HostUSER'	: 'ESX_USERNAME',
	'HostPASS'	: 'ESX_PASSWORD',
	'ServTYPE'	: 'Physical Packer|Virtual Packer|Offline Packer'
}

Response:

{
	'Code' : true|false
}

Error:

{
	TBD
}

Reference

List Available Replica

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtPrepareWorkload
Method: POST
Params:

{
	'Action'   : 'ListAvailableReplica',
	'AcctUUID' : STRING
}

Response:

{
	'REPL_UUID'				 : STRING,
	'HOST_NAME'				 : STRING,
	'REPL_MESG'				 : STRING,
	'PROGRESS_PRECENT'		 : INTEGER,
	'LOADER_PROGRESS_PRECENT': INTEGER,
	'REPL_TIME'				 : YYYY-MM-DD HH:MM:SS,
	'WINPE_JOB'				 : 'Y|N' 
}

Error:

{
	false
}

Display Job History

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtPrepareWorkload
Method: POST
Params:

{
	'Action'	: 'DisplayJobHistory'
	'JobsUUID'	: STRING,
	'ItemLimit' : INTEGER
}

Response:

{
	'time'		  : 'UNIX_TIME_STAMP',
	'unsync_time' : 'UNIX_TIME_STAMP',
	'state'		  :	INTEGER,
	'error'		  : INTEGER,
	'description' : STRING
}

Error:

{
	false
}

Sync Select Replica

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtPrepareWorkload
Method: POST
Params:

{
	'Action'	: 'SyncSelectReplica'
	'ReplUUID'	: STRING
}

Response:

{
	TBD
}

Error:

{
	TBD
}

Delete Select Replica

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtPrepareWorkload
Method: POST
Params:

{
	'Action'	: 'DeleteSelectReplica'
	'ReplUUID'	: STRING
}

Response:

{
	TBD
}

Error:

{
	TBD
}

Update Replica Interval Setting

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /EditConfigureSchedule
Method: POST
Params:

{
	'Action'			  : 'UpdateReplicaIntervalSetting'
	'ReplUUID'			  : STRING,
	'IntervalMinutes'	  : INTEGER,
	'SnapshotsNumber'	  : INTEGER,
	'UseBlockMode'		  : true|false,
	'WorkerThreadNumber'  : INTEGER,
	'LoaderThreadNumber'  : INTEGER,
	'LoaderTriggerNumber' : INTEGER,
	'StartTime'			  : 'YYYY-MM-DD HH:MM'
}

Response:

{
	'Code' : true
}

Error:

{
	'Code' : false
}

Query Host Information

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /PrepareWorkloadSummary
Method: POST
Params:

{
	'Action'			: 'QueryHostInformation'
	'HostUUID'			: STRING
}

Response:

{
	'ACCT_UUID' : STRING,
	'REGN_UUID' : STRING,
	'HOST_UUID' : STRING,
	'HOST_NAME' : STRING,
	'HOST_ADDR' : 'HOST_ADDRESS',
	'HOST_DISK' : [Object {HOST_UUID=STRING, DISK_UUID=STRING, DISK_NAME=STRING, more...}],
	'HOST_INFO' : Object {architecture=STRING, client_id=STRING, client_name=STRING, more...},
	'HOST_SERV' : Object {ACCT_UUID=STRING, REGN_UUID=STRING, SERV_UUID=STRING, more...},
	'HOST_TYPE'	: 'Physical|Virtual'
}

Error:

{
	TBD
}

Query Connection Information By ServUUID

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /PrepareWorkloadSummary
Method: POST
Params:

{
	'Action'	: 'QueryConnectionInformationByServUUID',				
	'HostUUID'	: STRING,	#HOST_UUID
	'LoadUUID'	: STRING, 	#LOADER_UUID
	'LaunUUID'	: STRING	#LAUNCHER_UUID
}

Response:

{
	'ACCT_UUID'	  : STRING,
	'SOURCE_CONN' : STRING,
	'TARGET_CONN' : STRING,
	'CONN_DATA'	  :	Object { ACCT_UUID=STRING, CONN_TYPE='LocalFolder|WebDav', SCHD_UUID=STRING,  more...},
	'CONN_TYPE'	  :	'LocalFolder|WebDav',
	'SERV_INFO'	  : Object { ACCT_UUID=STRING, REGN_UUID=STRING, SERV_UUID=STRING,  more...},
	'MGMT_ADDR'	  : 'MGMT_ADDRESS',
	'CLUSTER_UUID': STRING,
	'LAUN_UUID'	  : STRING
}

Error:

{
	false
}

Begin To Run Replica

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /PrepareWorkloadSummary
Method: POST
Params:

{
	'Action'   				  : 'BeginToRunReplica',				
	'RegnUUID' 				  : STRING,
	'HostUUID' 				  : STRING,
	'CarrUUID' 				  : STRING,
	'LoadUUID' 				  : STRING,
	'LaunUUID' 				  : STRING,
	'IntervalMinutes'   	  : INTEGER,
	'SnapshotsNumber'   	  : INTEGER,
	'UseBlockMode'      	  : true|false,
	'WorkerThreadNumber' 	  : INTEGER,
	'LoaderThreadNumber'	  : INTEGER,
	'LoaderTriggerPercentage' : INTEGER,
	'BufferSize'			  : INTEGER,
	'ChecksumVerify'		  : true|false,
	'SchedulePause'           : true|false,
	'StartTime'         	  : 'YYYY-MM-DD HH:MM'
	'TimeZONE' 				  : STRING,
	'MgmtADDR' 				  : 'MGMT_ADDRESS'
}

Response:

{
	TBD
}

Error:

{
	TBD
}

Query Replica Configuration

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /EditConfigureSchedule
Method: POST
Params:

{
	'Action'			  : 'QueryReplicaConfiguration'
	'ReplUUID'			  : STRING
}

Response:

{
	'type' 						: INTEGER,
	'triggers' 					: [Object { type=1,  interval="60",  start="",  more...}],
	'management_id' 			: STRING,
	'mgmt_addr'					: Object { IP_ADDRESS=0},
	'mgmt_port'					: INTEGER,
	'is_ssl'					: true|false,
	'worker_thread_number' 		: INTEGER,
	'block_mode_enable' 		: 0|1,
	'snapshot_rotation'			: INTEGER,
	'loader_thread_number' 		: INTEGER,
	'loader_trigger_percentage' : INTEGER,
	'buffer_size'				: INTEGER,
	'checksum_verify'			: true|false,
	'schedule_pause'			: true|false,
	'job_version'				: 'transport version number',
	'edit_lock'					: true|false,
	'is_executing'				: true|false,
	'init_loader'				: true|false,
	'timezone'					: 'timezone',
	'is_migration_executing'	: true|false,
	'user_set_time'				: 'UTC time'
}

Error:

{
	false
}

Reference

List Available Service

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtRecoverWorkload
Method: POST
Params:

{
	'Action'   : 'ListAvailableService',				
	'AcctUUID' : STRING
}

Response:

{
	'SERV_UUID' : STRING,
	'HOST_NAME' : STRING,
	'SERV_MESG' : STRING,
	'SERV_TIME' : 'UNIX_TIME_STAMP'
}

Error:

{
	false
}

Delete Select Recover

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /MgmtRecoverWorkload
Method: POST
Params:

{
	'Action'       : 'DeleteSelectRecover',				
	'ServUUID'     : STRING,
	'SaveInstance' : true|false
}

Response:

{
	TBD
}

Error:

{
	TBD
}

List Available OpenStack Disk

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /SelectListSnapshot
Method: POST
Params:

{
	'Action'    : 'ListAvailableOpenStackDisk',	
	'REPL_UUID' : STRING
}

Response:

{
	'OPEN_DISK_UUID' : STRING,
	'OPEN_SERV_UUID' : STRING,
	'OPEN_DISK_ID'   : STRING,
	'DEVICE_PATH'    : 'MOUNT_POINT',
	'REPL_UUID'      : STRING,
	'REPL_DISK_UUID' : STRING,
	'TIMESTAMP'      : 'YYYY-MM-DD HH:MM:SS',
	'STATUS'         : 'Y|N'
}

Error:

{
	TBD
}

List Available Snapshot

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /SelectListSnapshot
Method: POST
Params:

{
	'Action' 	  : 'ListAvailableSnapshot'
	'ClusterUUID' : STRING,
	'DiskUUID'	  : STRING
}

Response:

[
	{
		'status'     : "STATUS", #available
		'metadata'   :{
						 "UUID": STRING
				      },
		'name'       : STRING,
		'volume_id'  : STRING,
		'created_at' : 'YYYY-MM-DD hh:mm:ss',
		'size'       : INTERGER, #GB
		'id'         : STRING,
		'description': STRING
	}
]

Error:

{
	TBD
}

List Instance Flavors

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /InstanceConfigurations
Method: POST
Params:

{
	'Action' 	  : 'ListInstanceFlavors'
	'ClusterUUID' : STRING,
}

Response:

{
	'flavors' : [
				Object
					{
						name  ='type_name', 
						links = [  
								  ram = INTEGER, #MB
								  id  = STRING,
								  more...
								]
					}
				]
}

Error:

{
	TBD
}

List Internal Network

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /InstanceConfigurations
Method: POST
Params:

{
	'Action' 	  : 'ListInternalNetwork'
	'ClusterUUID' : STRING,
}

Response:

{
	'networks' : [
				Object
					{
					    status 	              = 'status',
						subnets               = [
										           INTEGER : STRING
									            ],
						name   	              = 'network_name',
						tenant_id             = STRING,
						mtu                   = INTEGER,
						provider:network_type = 'flat|vxlan',
						id                    = STRING
					}
				]
}

Error:

{
	TBD
}

List Security Group

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /InstanceConfigurations
Method: POST
Params:

{
	'Action' 	  : 'ListSecurityGroup'
	'ClusterUUID' : STRING,
}

Response:

{
	'security_groups' : [
				Object
					{
					    rules		= [ more... ],
						tenant_id	= STRING,
						id          = STRING,
						name   	    = 'security_groups_name',
						description	= [ more... ]
					}
				]
}

Error:

{
	TBD
}

Query Replica Information

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action'   	: 'QueryReplicaInformation',
	'REPL_UUID' : STRING
}

Response:

{
	'ACCT_UUID'   			  : 'STRING',
	'REGN_UUID'   			  : 'STRING',
	'REPL_UUID'   			  : 'STRING',
	'PACK_UUID'   			  : 'STRING',
	'CLUSTER_UUID' 			  : 'STRING',
	'CONN_UUID'   			  : {
									'SOURCE' : 'STRING',
									'TARGET' : 'STRING'
								},
	'JOBS_JSON'   			  : {
									'type':3,
									'triggers':[
												  {
													 'type':1,
													 'start':'',
													 'finish':'',
													 'interval':'60',
													 'id':''
												  }
												],
												'management_id':STRING,
												'mgmt_addr':{'MGMT_ADDRESS':0},
												'mgmt_port':443,
												'is_ssl':true,
												'worker_thread_number':INTEGER,
												'block_mode_enable':INTEGER,
												'snapshot_rotation':INTEGER,
												'job_version':'BUILD_NUMBER'
								},	
	'MGMT_ADDR'    			  : 'MGMT_ADDRESS',
	'WINPE_JOB'    			  : 'Y|N',
	'HOST_SERV'    			  : null,
	'HOST_NAME'               : STRING,
	'HOST_ADDR'               : 'HOST_ADDRESS',
	'BACKUP_SIZE'             : INTEGER,
	'PROGRESS_SIZE'           : INTEGER,
	'PROGRESS_PRECENT'        : '100.0',
	'PROGRESS_SPEED'          : '0.0',
	'LOADER_PROGRESS_PRECENT' : '100.0',
	'LOADER_PROGRESS_SPEED'   : '0.0',
	'REPL_MESG'				  : 'STRING',
	'SYNC_TIME'				  : 'UNIX_TIME_STAMP',
	'REPL_TIME'				  : 'YYYY-MM-DD hh:mm:ss'
}

Error:

{
	TBD
}

Query Flavor Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action' 	  : 'QueryFlavorInformation',
	'ClusterUUID' : STRING,
	'FlavorID'	  : 'FLAVOR_ID'
}

Response:

{
    'flavors' : [
                Object
                    {
                        name  ='type_name', 
                        links = [  
                                  ram = INTEGER, #MB
                                  id  = STRING,
                                  more...
                                ]
                    }
                ]
}

Error:

{
    TBD
}

Query Network Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action' 	  : 'QueryNetworkInformation',
	'ClusterUUID' : STRING,
	'NetworkUUID' : 'NETWORK_UUID'
}

Response:

{
    'networks' : [
                Object
                    {
                        status                = 'status',
                        subnets               = [
                                                   INTEGER : STRING
                                                ],
                        name                  = 'network_name',
                        tenant_id             = STRING,
                        mtu                   = INTEGER,
                        provider:network_type = 'flat|vxlan',
                        id                    = STRING
                    }
                ]
}

Error:

{
    TBD
}

Query Security Group Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action' 	  : 'QuerySecurityGroupInformation',
	'ClusterUUID' : STRING,
	'SgroupUUID'  : 'SECURITY_GROUP_UUID'
}

Response:

{
    'security_groups' : [
                Object
                    {
                        rules       = [ more... ],
                        tenant_id   = STRING,
                        id          = STRING,
                        name        = 'security_groups_name',
                        description = [ more... ]
                    }
                ]
}

Error:

{
    TBD
}

Query Snapshot Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action' 	  : 'QuerySnapshotInformation',
	'ClusterUUID' : STRING,
	'SnapUUID'    : 'SNAPSHOT_UUID'
}

Response:

{
	'status'     : "STATUS", #available
	'metadata'   :{
					 "UUID": STRING
				  },
	'name'       : STRING,
	'volume_id'  : STRING,
	'created_at' : 'YYYY-MM-DD hh:mm:ss',
	'size'       : INTERGER, #GB
	'id'         : STRING,
	'description': STRING
}

Error:

{
    TBD
}

Query Subnet Information

Address: http://127.0.0.1:8080/restful/OpenStackManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action' 	  : 'QuerySubnetInformation',
	'ClusterUUID' : STRING,
	'SubnetUUID'  : 'SUBNET_UUID'
}

Response:

{
    'subnet' : [
			Object
				{
					name       		  = STRING,
					enable_dhcp   	  = true|false,
					network_id        = STRING,
					tenant_id         = STRING,
					dns_nameservers   = [ more... ],
					gateway_ip		  = 'IP_ADDRESS',
					ipv6_ra_mode      = null,
					allocation_pools  = [ more... ],
					host_routes		  = null,
					ip_version		  = 4|6
					ipv6_address_mode = null
					cidr			  = 'CIDR_INFO'
					id				  = STRING,
					subnetpool_id	  = STRING
				}
			]
}

Error:

{
	TBD
}

Begin To Run Service

Address: http://127.0.0.1:8080/restful/ServiceManagement
UI Reference: /RecoverSummary
Method: POST
Params:

{
	'Action'	  : 'BeginToRunService',
	'AcctUUID'	  : STRING,
	'RegnUUID'	  : STRING,
	'ReplUUID'	  : STRING,
	'FlavorId'	  : 'FLAVOR_ID',
	'NetworkUUID' : 'NETWORK_UUID',
	'SgroupUUID'  : 'SECURITY_GROUP_UUID',
	'SnapUUID'    : 'SNAPSHOT_UUID',
	'ClusterUUID' : STRING,
	'TriggerSync' : 'on|off'
}

Response:

{
	TBD
}

Error:

{
	TBD
}