平安云|Ping An Cloud- Building Your Smart Future

1. ListDedicatedEbsProductSeries

Interface Description

List dedicated EBS product series

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
InstanceProductSeriesId	String	yes	ECS instance product series Id
RegionId	String	no	Region
ZoneId	String	no	available zone

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
ProductSeries	List<ProductSeriesBean>	Product series information list

2. CreateDedicatedHost

Interface Description

Create dedicated host machine. Dedicated host machine has its own unique label to identify the dedicated host.

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
ZoneId	String	yes	Available zone Id. Available zone of dedicated host machine, chose by users when creating parameter must be uploaded, type:n (positive integer)
PodId	String	yes	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.
HostTypeId	String	yes	Product specification Id. Product type, administrator attribute Field must be uploaded, entity verification will be performed, if verification failed, throw exception InvalidParameterException
VirtaulType	String	yes	Virtual type. Dedicated host machine default type KVM Field must be uploaded
ChargeType	ChargeType	yes	Charge mode. Dedicated host machine temporarily only accept paid by month. Field must be uploaded
Period	Integer	yes	Periods Fields must be uploaded
Count	Integer	yes	Amount Fields must be uploaded
DisplayName	String	no	Display name. Fields must be uploaded. The longest length of name can be displayed is 20, if exceed, then it will throw PacloudException abnormal.

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
ChargeType	ChargeType	Charge type, dedicated host machine currently only support monthly payment
ProductCode	String	Product code. Product dedicated code of host machine
OrderId	String	Oder Id
Status	OrderStatus	Order Status
ProductCode	String	Product code. Product dedicated code of host machine

3. DestroyDedicatedHost

Interface Description

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

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated host machine Id entity verification will be performed, if verification failed it will throw exception InvalidParameterException

Response Parameter

Parameter Type

Parameter Description

Remarks

4. GetDedicatedEcsSummary

Interface Description

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.

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
RegionId	String	yes	Region Id. Field must be uploaded, entity verification will be performed, region existence will be checked, if verification failed, it will throw exception InvalidParameterException

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
HostSum	Long	Total number of host machine unit: piece
InstanceSum	Long	Total number of ECS instance unit: piece
DiskSum	Long	Total amount of disk unit:piece

5. ListDedicatedHostTypes

Interface Description

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.

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
RegionId	String	yes	Region Id. Fields must be uploaded. Data comes from base service
ZoneId	String	yes	Available zone id. Fields must be uploaded. Data comes from base service

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
DedicatedHostTypes	List<DedicatedHostTypeBean>	Dedicated host machine type list. Dedicated host machine type equipped by administrator includes price, memory, cpu, click on Bean for details
TotalCount	Long	Total amount of host machine. Total amount of all the valid dedicated host machines equipped

6. ListDedicatedHosts

Interface Description

List dedicated hosts machine. Page query dedicated host machines, support condition query, condition query, sorting order and default sorting order is by id desc.

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Name	String	no	Name of dedicated host machine
Status	HostStatus[]	no	Dedicated host machine Status. Determine Status of creating or running the current host machine
PageNumber	Integer	yes	Page number
PageSize	Integer	yes	Page size
RegionId	String	yes	RegionId Entity verification will be performed, data comes from base service, if it does not exist, then verification fails and throw exception InvalidParameterException
PodId	String	no	High available zone Id. Entity verification will be performed, data comes from iaas service, if it does not exist, then verification fails and throw exception InvalidParameterException
ZoneId	String	no	Available zone Id Entity verification will be performed, data comes from base service, if it does not exist, then verification fails and throw exception InvalidParameterException

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
DedicatedHosts	List<DedicatedHostBean>	Dedicated host machine type list. Used to display details
TotalCount	Long	Amount. Number of valid host machine

7. ModifyHostAttribute

Interface Description

Modify host machine attribute. Mainly used to provide modification for dedicated host machine disPlayName. List the corresponding dedicated host machine according to id, modify the disPlayName attribute

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated host machine Id Entity verification will be performed, data come from Table:dedicated_host service, verification failure will throw exception InvalidParameterException
DisplayName	String	no	Display name of dedicated host machine The longest length of name can be displayed is 20.

Response Parameter

Parameter Name

Parameter Type

Parameter Description

Remarks

8. RenewDedicatedHost

Interface Description

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

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated host machine Id Entity verification will be performed, data come from Table:dedicated_host service, verification failure will throw exception InvalidParameterException
Period	Integer	yes	Renewing period of dedicated host machine

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
OrderId	String	Oder Id
Status	OrderStatus	Order Status
ProductCode	String	Product Code

9. ChangeDedicatedInstanceType

Interface Description

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.

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated ECS Id Fields must be uploaded. Entity verification will be performed, verification failure will throw exception InvalidParameterException
CPUNumber	Integer	yes	Dedicated ECS CPU Core number. Field must be uploaded
Memory	Integer	yes	Dedicated ECS memory. Fields must be uploaded

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
JobId	String	Job Id

10. DestroyDedicatedInstance

Interface Description

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

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated ECS Id. Fields must be uploaded. Entity verification will be performed, if verification failes, it will throw exception InvalidParameterException
CheckDependency	Boolean	no	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

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
JobId	String	Job Id

11. ListDedicatedInstanceCpus

Interface Description

Query all the cpus of dedicated ECS type, get all the dedicated ECS cpu types information

Request Parameter

Parameter Name

Parameter Type

Required (yes/no)

Parameter Description

Remarks

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
Cpus	List<Integer>	Dedicated host machine CPU list

12. ListDedicatedInstanceMemorys

Interface Description

Query dedicated ECS memories, get all the dedicated ECS memory types information

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Cpu	Integer	no	Dedicated ECS CPU Core amount of CPU in ECS created in dedicated physical machine

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
Memorys	List<Integer>	Dedicated host machine memory information list

13. RunDedicatedInstances

Interface Description

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

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
RegionId	String	yes	Region Id. Entity verification will be performed, verification failure will throw exception InvalidParameterException. Fields must be uploaded, be able to query ListRegions for details
ZoneId	String	yes	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.
PodId	String	yes	High available zone Id. Entity verification will be performed, verification failure will throw exception InvalidParameterException Fields must be uploaded, can list ListPods for details
NetworkId	String	yes	Network Id. Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListNetWorks for details
SubnetId	String	no	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 exceed, it will throw exception PacloudException.
ImageId	String	yes	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
DisplayName	String	no	Display name Including Chinese, English letters, numbers, @ and _, -, the longest length to display name is 20 digits.
Count	Integer	yes	Count
DiskType	String	no	Producttype. Entity verificationwillbe performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list DTO method for details. 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.
DiskSizes	Integer[]	no	List of disk size. The size of disk ranges from 20-2000
HostId	String	yes	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
CpuNumber	Integer	yes	Number of CPU. The value is 1, 2, 4, 8 etc., the largest one is 1024
MemNumber	Integer	yes	Amount of memory, The value is 2, 4, 8 etc., the largest one is 1024

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
JobIds	List<String>

14. StartDedicatedInstance

Interface Description

Start dedicated ECS, the interface is asynchronous job, execute to return job uuid to check the task

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated host machine Id. Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListInstances for details

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
JobId	String	Job Id

15. StopDedicatedInstance

Interface Description

Stop dedicated ECS, the interface is an asynchronous job, return job uuid can query whether the interface task is successfully executed according to uuid

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Dedicated host machine Id Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListInstances for details

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
JobId	String	Task Id

16. CreateDedicatedSnapshotPolicy

Interface Description

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

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
EbsId	String	yes	EBS Id Dedicated ECS id Fields must be uploaded
IntervalType	IntervalType	yes	Periods Fields must be uploaded Specific valid period
Schedule	String	yes	Fields must be uploaded
MaxSnaps	Integer	yes	The maximum copies of snapshot to reserve Fields must be uploaded
DisplayName	String	no	Policy display name The longest length is 20 character
RegionId	String	yes	RegionId Fields must be uploaded Entity verification will be performed, if verification failed, it will throw exception InvalidParameterException Fields must be uploaded, can list ListRegions for details

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
SnapshotPolicy	SnapshotPolicyBean	Snapshot policy Related information

17. DeleteDedicatedSnapshotPolicy

Interface Description

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

Request Parameter

Parameter Name	Parameter Type	Required (yes/no)	Parameter Description	Remarks
Id	String	yes	Snapshot policy 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

Response Parameter

Parameter Name	Parameter Type	Parameter Description	Remarks
JobId	String	Job Id

Did the above content solve your problem? Yes No