CaaS / CVPC API Developer Center

VM

Direction

describeInstances is used to list the detailed information on more than one set of VMs. If there are no parameters instanceId or orderUuid, the information on all the VMS would be listed. For VM’s default ID and password, please click “VM Default password” after entering the user. The password for archive file is the last four codes of the ID.

Request Parameter

Parameter Directions Note
instanceId   

(Not a necessary parameter)

Source VM Instance ID
Type : String
Default Value : No
Whether it is plural : Yes
Multiple values can be supported.
orderUuid   

(Not a necessary parameter)

List of Order Number
Type : String
Default Value : No
Whether it is plural : Yes
Multiple values can be supported.

businessTag

(Not a necessary parameter)

business tag
Type : String
Default Value : No
Whether it is plural : No
refer to Business Tag

vpcBusinessServiceId

(Not a necessary parameter)

vpc business service id
Type : String
Default Value : No
Whether it is plural : No

Response Parameter

Parameter Directions Note
requestId     

(Not a necessary parameter)

Request ID
Type : JSON value : string
Whether it is plural : No
Automatically produced by the system
instanceList VM Information
Type : JSON value : array
Whether it is plural : No(List)
VirtualMachineEntry List

Request Example

Example1:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeInstances
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

Example2:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeInstances
&instanceId=BV550100010003
&instanceId=BV550100010004
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
		

Response Example

[
	"requestId":"xxxEXAMPLE",
	{
		"orderUuid": "75cee802-1ed4-4a2a-8078-ca0a29deeff0",
		"instanceId": "BV550100010003",
		"applyDate": "2012-01-01T01:01:01Z",
		"startDate": "2012-01-01T01:01:01Z",
		"endDate": null,
		"name": "myVm01",
		"operationStatus": "vmStart",
		"provisionStatus": "provisioning",
		"provisionMessage": null,
		"ipForNat": "172.10.10.1",
		"ipForVm": "192.168.150.1",
		"businessTag": "9a92f90c-532a-4a5d-9e3c-0c1805bc2583",
		"regionId": "region-tw-1"
	},
	{
		"orderUuid": "0762e00f-df4b-48d0-93bd-4f355c85b2d8",
		"instanceId": "BV550100010004",
		"applyDate": "2012-01-01T01:01:01Z",
		"startDate": "2012-01-01T01:01:01Z",
		"endDate": null,
		"name": "myVm01",
		"operationStatus": "vmStart",
		"provisionStatus": "provisioning",
		"provisionMessage": null,
		"ipForNat": "172.10.10.1",
		"ipForVm": "192.168.150.1",
		"businessTag": "9a92f90c-532a-4a5d-9e3c-0c1805bc2583",
		"regionId": "region-tw-1"
	}
]
		

Error Code

OrderProcessFail