查询磁盘产品信息
功能介绍
查询磁盘产品信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/volume/products
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
availability_zone |
否 |
String |
可用分区。 |
|
volume_type |
否 |
String |
磁盘类型(多个磁盘类型用逗号隔开):
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
是 |
String |
发送的实体的MIME类型,如:application/json。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
volumes |
Array of VolumeProductInfo objects |
磁盘产品信息列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_spec_code |
String |
产品ID。 |
|
volume_type |
String |
磁盘类型:
|
|
volume_product_type |
String |
产品类型:workspace。 |
|
resource_type |
String |
资源类型。 |
|
cloud_service_type |
String |
云服务类型。 |
|
domain_ids |
Array of strings |
该磁盘支持的专有域id(domainId)。 |
|
name |
Array of I18nLanguage objects |
磁盘名称。 |
|
status |
String |
产品状态,normal:正常、sellout:售空。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
/v2/0e3f393ae380f5d12facc005678bcd4b/volume/products?vailability_zone=cn-north-4a&volume_type=SSD,SAS
响应示例
状态码:200
查询云硬盘类型列表响应。
{
"volumes" : [ {
"resource_spec_code" : "workspace.volume.ultrahigh",
"volume_type" : "SSD",
"volume_product_type" : "workspace",
"resource_type" : "hws.resource.type.workspace.volume",
"cloud_service_type" : "hws.service.type.vdi",
"name" : [ {
"language" : "en-us",
"value" : "Ultra high IO Disk"
}, {
"language" : "zh-cn",
"value" : "超高IO磁盘"
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询云硬盘类型列表响应。 |
|
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。