API Description

<p><strong>1.&nbsp;ListDedicatedEbsProductSeries</strong></p> <p><strong>Interface Description</strong></p> <p>List dedicated EBS product series</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>InstanceProductSeriesId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>ECS instance product series Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Region</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>available zone</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ProductSeries</p> </td> <td> <p>List&lt;ProductSeriesBean&gt;</p> </td> <td> <p>Product series information list</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2.&nbsp;CreateDedicatedHost</strong></p> <p><strong>Interface Description</strong></p> <p>Create dedicated host machine. Dedicated host machine has its own unique label to identify the dedicated host.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Available zone Id. Available zone of dedicated host machine, chose by users when creating parameter must be uploaded, type:n (positive integer)</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PodId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>High available zone Id. High available zone Id of dedicated host machine, chose by users when create parameter must be uploaded, type:n (positive integer) entity verification will be made, if failed, exception InvalidParameterException will be thrown.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>HostTypeId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Product specification Id. &nbsp;Product type,&nbsp; administrator attribute&nbsp; Field must be uploaded, entity verification will be performed, if verification failed, throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>VirtaulType</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Virtual type. Dedicated host machine default type KVM Field must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>yes</p> </td> <td> <p>Charge mode. Dedicated host machine temporarily only accept paid by month. Field must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Period</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Periods Fields must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Amount&nbsp; Fields must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name. Fields must be uploaded. The longest length of name can be displayed is 20, if exceed, then it will throw PacloudException abnormal.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>Charge type, dedicated host machine currently only support monthly payment</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code. Product dedicated code of host machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Oder Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order Status</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code. Product dedicated code of host machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3.&nbsp;DestroyDedicatedHost</strong></p> <p><strong>Interface Description</strong></p> <p>Destroy dedicated host machine if the Status of the dedicated host machine destroyed is: Pending Destroying Destoryed will throw PacloudException, the dedicated host machine destroyed is soft destroy, modify Status EnableFlag =no and status = destroyed</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated host machine Id entity verification will be performed, if verification failed it will throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>Response Parameter</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p>&nbsp;</p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4.&nbsp;GetDedicatedEcsSummary</strong></p> <p><strong>Interface Description</strong></p> <p>Get dedicated ECS overview. To obtain an overview of dedicated ECS To dedicated host machine configuration information such as: quantity, size of memory, cpu, disk space, total number of real instance and etc, the incoming parameter is regionID.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region Id. Field must be uploaded, entity verification will be performed, region existence will be checked, if verification failed, it will throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>HostSum</p> </td> <td> <p>Long</p> </td> <td> <p>Total number of host machine unit: piece</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>InstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>Total number of ECS instance unit: piece</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSum</p> </td> <td> <p>Long</p> </td> <td> <p>Total amount of disk unit:piece</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5.&nbsp;ListDedicatedHostTypes</strong></p> <p><strong>Interface Description</strong></p> <p>List dedicated host machine types. Support the query of dedicated host machine types, which configurated by administrators. Used to create dedicated host to provide type configuration.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region Id. Fields must be uploaded. Data comes from base service</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Available zone id. Fields must be uploaded. Data comes from base service</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DedicatedHostTypes</p> </td> <td> <p>List&lt;DedicatedHostTypeBean&gt;</p> </td> <td> <p>Dedicated host machine type list. Dedicated host machine type equipped by administrator includes price, memory, cpu, click on Bean for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total amount of host machine. Total amount of all the valid dedicated host machines equipped</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6.&nbsp;ListDedicatedHosts</strong></p> <p><strong>Interface Description</strong></p> <p>List dedicated hosts machine. Page query dedicated host machines, support condition query, condition query, sorting order and default sorting order is by id desc.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Name of dedicated host machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>HostStatus[]</p> </td> <td> <p>no</p> </td> <td> <p>Dedicated host machine Status. Determine Status of creating or running the current host machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Page number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Page size</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>RegionId Entity verification will be performed, data comes from base service, if it does not exist, then verification fails and throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PodId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>High available zone Id.&nbsp; Entity verification will be performed, data comes from iaas service, if it does not exist, then verification fails and throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Available zone Id&nbsp; Entity verification will be performed, data comes from base service, if it does not exist, then verification fails and throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DedicatedHosts</p> </td> <td> <p>List&lt;DedicatedHostBean&gt;</p> </td> <td> <p>Dedicated host machine type list. Used to display details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Amount. Number of valid host machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7.&nbsp;ModifyHostAttribute</strong></p> <p><strong>Interface Description</strong></p> <p>Modify host machine attribute. Mainly used to provide modification for dedicated host machine disPlayName. &nbsp;List the corresponding dedicated host machine according to id, modify the disPlayName attribute</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated host machine Id&nbsp; Entity verification will be performed, data come from Table:dedicated_host service, verification failure will throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name of dedicated host machine The longest length of name can be displayed is 20.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8.&nbsp;RenewDedicatedHost</strong></p> <p><strong>Interface Description</strong></p> <p>Renew dedicated host machine renew. For dedicated host machine payment renewal its payment type has to be of monthly paid type, if not, IncorrectStatusException exception error will occur, other payment renewal condition includes that the dedicated host machine Status cannot have exceptional Status such as Pending Createfial Destory, for renewal of new payment periods</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated host machine Id&nbsp; Entity verification will be performed, data come from Table:dedicated_host service, verification failure will throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Period</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Renewing period of dedicated host machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Oder Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order Status</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product Code</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>9.&nbsp;ChangeDedicatedInstanceType</strong></p> <p><strong>Interface Description</strong></p> <p>Change dedicated ECS type, during changing the type, the host machine must be shut down, the changed value should be different from the original one, the quota is valid, no other operation of the machine is performed, or throw the exception InvalidParameterException into asynchronous job task, return to the jobuuid to see whether the task is successfully executed.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated ECS Id Fields must be uploaded. Entity verification will be performed, verification failure will throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CPUNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated ECS CPU Core number. Field must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Memory</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated ECS memory. Fields must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>10. DestroyDedicatedInstance</strong></p> <p><strong>Interface Description</strong></p> <p>Destroy dedicated ECS, The Interface is to execute an asynchronous job to destroy ECS instance, return to job uuid can check whether the task jobuuid is successfully executed</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated ECS Id. Fields must be uploaded. Entity verification will be performed, if verification failes, it will throw exception InvalidParameterException</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CheckDependency</p> </td> <td> <p>Boolean</p> </td> <td> <p>no</p> </td> <td> <p>Whether query resource dependence relation, defaulted as yes. If dependence relation queried queries when deleting, then the dependent resource will be deleted and throw exception DependencyExistException</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>11.&nbsp;ListDedicatedInstanceCpus</strong></p> <p><strong>Interface Description</strong></p> <p>Query all the cpus of dedicated ECS type, get all the dedicated ECS cpu types information</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Cpus</p> </td> <td> <p>List&lt;Integer&gt;</p> </td> <td> <p>Dedicated host machine CPU list</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>12. ListDedicatedInstanceMemorys</strong></p> <p><strong>Interface Description</strong></p> <p>Query dedicated ECS memories, get all the dedicated ECS memory types information</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Cpu</p> </td> <td> <p>Integer</p> </td> <td> <p>no</p> </td> <td> <p>Dedicated ECS CPU&nbsp; Core amount of CPU in ECS created in dedicated physical machine</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Memorys</p> </td> <td> <p>List&lt;Integer&gt;</p> </td> <td> <p>Dedicated host machine memory information list</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>13. RunDedicatedInstances</strong></p> <p><strong>Interface Description</strong></p> <p>Create dedicated ECS, Enable batch creation of dedicated ECS on dedicated host machine, and create a job for asynchronous ECS creation to return to jobuuid. Be able to check whether it has been successfully created by returned uuid</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Region Id. Entity verification will be performed, verification failure will throw exception InvalidParameterException. Fields must be uploaded, be able to query ListRegions for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Available Zone Id. Entity verification will be performed, verification failure will throw exception InvalidParameterException Fields must be uploaded, be able to query details by ListZones.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PodId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>High available zone Id. Entity verification will be performed, verification failure will throw exception InvalidParameterException Fields must be uploaded, can list ListPods for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>NetworkId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Network Id. Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListNetWorks for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>SubnetId</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Subnet Id. Entity verification will be performed, verification failure will throw exception InvalidParameterException Fields must be uploaded, be able to query details by ListSubnets. The longest length is 36, if&nbsp; exceed, it will throw exception PacloudException.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ImageId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Operating system image Id. Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListImages for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Display name Including Chinese, English letters, numbers, @ and _, -, the longest length to display name is 20 digits.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Count</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskType</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Producttype. Entity verificationwillbe performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list DTO method for details.&nbsp; Each EBS type in the portal has corresponding EBS product specification, for example, the SSD cloud drive corresponds to the product specification name as ebs.s1.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DiskSizes</p> </td> <td> <p>Integer[]</p> </td> <td> <p>no</p> </td> <td> <p>List of disk size. The&nbsp; size of&nbsp; disk ranges from 20-2000</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>HostId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Host machine Id, Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListDedicatedHosts method for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CpuNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Number of CPU.&nbsp; The value is 1, 2, 4, 8 etc., the largest one is 1024</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MemNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>Amount of memory, The value is 2, 4, 8 etc., the largest one is 1024</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobIds</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>14.&nbsp;StartDedicatedInstance</strong></p> <p><strong>Interface Description</strong></p> <p>Start dedicated ECS, the interface is asynchronous job, execute to return job uuid to check the task</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated host machine Id.&nbsp; Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListInstances for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>15.&nbsp;StopDedicatedInstance</strong></p> <p><strong>Interface Description</strong></p> <p>Stop dedicated ECS, the interface is an asynchronous job, return job uuid can query whether the interface task is successfully executed according to uuid</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Dedicated host machine Id&nbsp; Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListInstances for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Task Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>16.&nbsp;CreateDedicatedSnapshotPolicy</strong></p> <p><strong>Interface Description</strong></p> <p>Create dedicated snapshot policy by dedicated ECS, When ECS expired, creating snapshot is not allowed the interface is an asynchronous job to create and query whether the snapshot Status is successfully created</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p>Parameter Name</p> </td> <td> <p>Parameter Type</p> </td> <td> <p>Required (yes/no)</p> </td> <td> <p>Parameter Description</p> </td> <td> <p>Remarks</p> </td> </tr> <tr> <td> <p>EbsId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>EBS Id Dedicated ECS id Fields must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IntervalType</p> </td> <td> <p>IntervalType</p> </td> <td> <p>yes</p> </td> <td> <p>Periods Fields must be uploaded Specific valid period</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Schedule</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Fields must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>MaxSnaps</p> </td> <td> <p>Integer</p> </td> <td> <p>yes</p> </td> <td> <p>The maximum copies of snapshot to reserve&nbsp; Fields must be uploaded</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>DisplayName</p> </td> <td> <p>String</p> </td> <td> <p>no</p> </td> <td> <p>Policy display name The longest length is 20 character</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>RegionId Fields must be uploaded&nbsp; Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListRegions for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>SnapshotPolicy</p> </td> <td> <p>SnapshotPolicyBean</p> </td> <td> <p>Snapshot policy Related information</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>17.&nbsp;DeleteDedicatedSnapshotPolicy</strong></p> <p><strong>Interface Description</strong></p> <p>Delete dedicated snapshot policy. A deleted snapshot policy cannot be deleted again. The interface is for asynchronous deletion, can confirm whether the deletion was successful based on the snapshot policy Status</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (yes/no)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>yes</p> </td> <td> <p>Snapshot policy&nbsp; Fields must be uploaded. Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListSnapshotPolicies for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products