CaaS / CVPC API 开发者中心

云服务器

使用说明

describeInstances主要是用于列出一组以上云服务器的详细信息。 若没有instanceId或orderUuid的参数,则会列出所有云服务器的信息。 关于云服务器的预设帐号密码,请在进入用户入口后,点选 "下载云服务器列表预设密码",此压缩文件的密码为身证号或营业执照号后四码。

Request 参数

参数 说明 备注
instanceId   

(非必要参数)

主机服务标识号列表
类型 : String
默认值 : 无
是否为复数型态 : 是
可支持多值
orderUuid   

(非必要参数)

订单编号列表
类型 : String
默认值 : 无
是否为复数型态 : 是
可支持多值

businessTag

(非必要参数)

业务类别
类型 : String
预设值 : 无
是否为复数型态 : 否
请参考 业务类别

vpcBusinessServiceId

(非必要参数)

软体资料中心服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

Response 参数

参数 说明 备注
requestId     

(非必要参数)

请求标识号
类型 : JSON value : string
是否为复数型态 : 否
系统自动生成
instanceList 云服务器信息
类型 : JSON value : array
是否为复数型态 : 是(List)
VirtualMachineEntry列表

businessTag

(非必要参数)

业务类别
类型 : String
预设值 : 无
是否为复数型态 : 否

vpcBusinessServiceId

(非必要参数)

软体资料中心服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

Request示例

	示例1:
	https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeInstances
	&chtAuthType=hwspass
	&version=${version}
	&expires=${expires}
	&accessKey=${accessKey}
	&signature=${signature}
	
	示例2:
	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示例

[
	"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"
	}
]
		

错误信息

OrderProcessFail