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

文档中心

立即注册

导航

云服务器

DescribeReservedStorageCapacity

最近更新时间：2024.11.26 10:11:19首次发布时间：2024.08.15 10:37:02

调用DescribeReservedStorageCapacity接口查询预留存储容量包。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeReservedStorageCapacity	要执行的操作，取值：PurchaseReservedInstancesOffering
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ZoneId	String	否	cn-beijing-a	预留存储容量包所在的可用区。说明预留存储容量包所在地域默认为请求的Region，即Header中的Region。
ReservedStorageCapacityIds	Array of string	否	rsc-3vpnts78dk3x35cj****	预留存储容量包ID。
ReservedStorageCapacityName	String	否	RSC01	预留存储容量包的名称。
VolumeType	String	否	ESSD_PL0	预留存储容量包预留的云盘规格，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格
Status	Integer	否	available	预留存储容量包的状态，取值说明如下： creating：创建中 available：生效中 terminated：已失效
PageNumber	Integer32	否	1	查询的页码。
PageSize	Integer32	否	100	分页查询时，设置的每页行数。

返回数据

名称	类型	示例值	描述
PageNumber	Integer32	1	当前页码。
PageSize	Integer32	100	每页行数。
TotalCount	Integer32	5	预留存储容量包的个数
RscInfo	Array of ReservedStorageCapacityInfo	-	预留存储容量包信息，具体请见下表“RscInfo”结构。

RscInfo结构

名称	类型	示例值	描述
ID	String	rsc-3vpnts78dk3x35cj****	预留存储容量包ID。
Name	String	rsc01	预留存储容量包的名称。
ZoneId	String	cn-beijing-a	预留存储容量包所在可用区。
Type	String	ESSD_PL0	预留存储容量包预留的云盘规格，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格
AccountId	String	21000****	预留存储容量包所属账号ID。
Status	String	available	预留存储容量包的状态，取值说明如下： creating：创建中 available：生效中 terminated：已失效
Size	Integer64	600	预留存储容量包的容量。
RemainingSize	Integer32	50	预留存储容量包未抵扣比例，计算方式为已使用时长/购买的总时长。
TakeEffectTime	String	2024-06-24T14:00:00+08:00	预留存储容量包的生效时间。
ExpiredTime	String	2024-07-24T23:59:59+08:00	预留存储容量包的到期时间。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024062417413927C74A735FA3DB2EF331-7d****",
        "Action": "DescribeReservedStorageCapacity",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 15,
        "RscInfo": [
            {
                "AccountId": "210015****",
                "ExpiredTime": "2024-07-24T23:59:59+08:00",
                "Id": "rsc-3vpnts78dk3x35cj****",
                "Name": "RSC01",
                "RemainingSize": 99,
                "Size": 20,
                "Status": "available",
                "TakeEffectTime": "2024-06-24T14:00:00+08:00",
                "Type": "ESSD_PL0",
                "ZoneId": "cn-beijing-a"
            },
            {
                "AccountId": "210015****",
                "ExpiredTime": "2024-09-24T23:59:59+08:00",
                "Id": "rsc-3vpnh9p8a23oigyh****",
                "Name": "RSC-bQrX",
                "RemainingSize": 99,
                "Size": 20,
                "Status": "available",
                "TakeEffectTime": "2024-06-24T11:00:00+08:00",
                "Type": "ESSD_PL0",
                "ZoneId": "cn-beijing-a"
            },
            {
                "AccountId": "210015****",
                "ExpiredTime": "2024-07-04T23:59:59+08:00",
                "Id": "rsc-3vo7vkg5ot5a711e****",
                "Name": "RSC-CpjO",
                "RemainingSize": 33,
                "Size": 20,
                "Status": "available",
                "TakeEffectTime": "2024-06-04T15:00:00+08:00",
                "Type": "ESSD_PL0",
                "ZoneId": "cn-beijing-b"
            }
        ],
        "TotalCount": 3
    }
}

错误码

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