DescribeVolumeType--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeVolumeType

最近更新时间：2024.11.01 18:49:26首次发布时间：2023.08.22 16:29:22

调用DescribeVolumeType接口查询各地域可用区支持创建的云盘类型。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeVolumeType	要执行的操作，取值：DescribeVolumeType。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
VolumeTypeIds.N	String	否	VolumeTypeIds.1=ESSD_FlexPL	需要查询的云盘类型，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格。 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。默认查询所有云盘类型。说明关于云盘规格的详细说明，请参见云盘规格。
ZoneId	String	否	cn-beijing-a	需要查询的地域，默认查询所有地域。注意 `ZoneId`的值必须填写为可用区，例如您想查询北京地域支持创建的云盘类型，您需要设置`ZoneId`为`cn-beijing-a`。
PageNumber	Int	否	1	起始页码，默认值为1。
PageSize	Int	否	50	页大小，最大100，默认值为50。

返回数据

名称	类型	示例值	说明
PageNumber	Int	1	页数索引。
PageSize	Int	50	分页的页容量。
TotalCount	Int	1	符合条件的云盘类型总数。
VolumeTypes	Array of object VolumeType	-	符合条件的云盘类型信息。具体请参见下表"VolumeTypes结构"。

VolumeTypes结构

名称	类型	示例值	说明
Id	String	ESSD_FlexPL	云盘类型，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格。 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。
Zones	Array of String	cn-beijing-a	该云盘类型所在可用区。

名称

类型

示例值

说明

String

ESSD_FlexPL

云盘类型，取值说明如下：

ESSD_PL0：极速型SSD云盘，PL0规格。
ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。

Zones

Array of String

cn-beijing-a

该云盘类型所在可用区。

请求示例

GET /?Action=DescribeVolumeType&Version=2020-04-01&VolumeTypeIds.1=ESSD_FlexPL HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230822162120F67350519DEA312F****",
        "Action": "DescribeVolumeType",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 50,
        "TotalCount": 1,
        "VolumeTypes": [
            {
                "Id": "ESSD_FlexPL",
                "Zones": [
                    "cn-beijing-a",
                    "cn-beijing-b",
                    "cn-beijing-c"
                ]
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。