CaaS / CVPC API Developer Center

EBS

Directions

describeVolumes is used to list the detailed information on more than one set of storage space. If there are no parameters volumeId or orderUuid, the information would be listed according to vpcBusinessServiceId and businessTag parameters. If there are no any parameters set, the information of all the CaaS-business storage space would be listed.

Request Parameter

Parameter Directions Note

volumeId

(Not a necessary parameter)

List of EBS Instance ID
Type : String
Default Value : No
Whether it is plural : Yes
Multiple values can be supported

orderUuid

(Not a necessary parameter)

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

vpcBusinessServiceId

(Not a necessary parameter)

VPC platform ID
Type : String
Default Value : No
Whether it is plural : No

businessTag

(Not a necessary parameter)

business tag
Type : String
Default Value : Yes
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
It is automatically produced by the system
volumeList List of EBS Information
Type : JSON value : array
Whether it is plural : Yes
EbsEntry List

Request Example

Example 1: (list all the information of CaaS-business storage space)
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeVolumes
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

Example 2: (list information of target storage space)
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeVolumes
&volumeId=BS550100010003
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

Example 3: (list storage space information of target vpc platform)
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeVolumes
&vpcBusinessServiceId=VV550100010001
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

		

Response Example

[
	"requestId":"xxxEXAMPLE",
	{
		"orderUuid": "cvghe802-1ed4-4a2a-8078-ca0a29deeff0",
		"volumeId": "BS550100010003",
		"applyDate": "2012-01-01T01:01:01Z",
		"startDate": "2012-01-01T01:02:01Z",
		"endDate": null,
		"name": "myVolume01",
		"operationStatus": "mount",
		"provisionStatus": "provisionok",
		"provisionMessage": null,
		"businessTag": "9a92f90c-532a-4a5d-9e3c-0c1805bc2583",
		"radix": 1,
		"instanceId": "BV550100010003",
		"regionId": "region-tw-1"
	},
	{
		"orderUuid": "pe0fkd0f-df4b-48d0-93bd-4f355c85b2d8",
		"volumeId": "BS550100010004",
		"applyDate": "2012-01-01T01:01:01Z",
		"startDat": "2012-01-01T01:02:01Z",
		"endDate": null,
		"name": "myVolume02",
		"operationStatus": "mount",
		"provisionStatus": "provisionok",
		"provisionMessage": null,
		"businessTag": "9a92f90c-532a-4a5d-9e3c-0c1805bc2583",
		"radix": 1,
		"instanceId": "BV550100010004",
		"regionId": "region-tw-1"
	}
]

		

Error Message

OrderProcessFail