获取存储卷资源列表

获取存储卷资源列表

Path Parameters

subscription_name string required

订阅

resource_group_name string required

资源组

zone string required

可用区

Query Parameters

filter string

过滤

order_by string

排序结果

page_size int32

返回当前页的最大条目数

page_token string

从上一个List请求返回的next_page_token值(如果有的话)

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

virtual_volumes object[]
存储卷资源列表
Array [
id string required
存储卷资源 id
name string required
存储卷资源名称
display_name string
Possible values: <= 63 characters
存储卷资源别名
description string
存储卷资源描述
uid string required
存储卷资源的uuid
resource_type string
存储卷资源的资源类型
creator_id string
创建VirtualVolume resource的用户id
owner_id string
拥有VirtualVolume resource的用户id
tenant_id string
租户id
zone string required
可用区
state enum
Possible values: [CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, EXPIREDOWNGRADING, EXPIREDOWNGRADED, RENEWUPGRADING, EXPIRESTOPPING, EXPIRESTOPPED, RENEWSTARTING, DOWNGRADING, DOWNGRADE, RESTORING]
存储卷资源状态
sku_id string
最小库存单元id
tags object
存储卷资源的标签
property name* string
properties object
存储卷资源属性
resources object
资源规格属性
billing_items object
计费项
capacity int32
创建存储卷资源容量
capacity_unit enum
Possible values: [EB, PB, TB, GB, MB]
创建存储卷资源容量单位
order_info object
订单信息
billing_cycle_number int32
购买时长
auto_renew boolean
自动续费
currency_code string
货币代码
payment_channel enum
Possible values: [PC_UNSPECIFIED, PC_BALANCE, PC_CREDIT, PC_FROZENACCOUNT, PC_REMIT_OFFLINE, PC_ALIPAY, PC_UNIONPAY, PC_REMIT_ONLINE, PC_CONTRACT]
支付方式
note string
订单备注
order_type enum
Possible values: [OT_UNSPECIFIED, OT_ORIGINAL, OT_RENEW, OT_UPGRADED, OT_DOWNGRADED, OT_CONTRACT, OT_UNSUBSCRIBE, OT_RESIZE]
订单类型
order_id string
订单id
start_time date-time
订单生效日期
payment_model enum
Possible values: [PM_UNSPECIFIED, PM_PREPAID, PM_POSTPAID]
付费类型
billing_model enum
Possible values: [BM_UNSPECIFIED, BM_USAGE, BM_MONTHLY, BM_YEARLY]
计费类型
original_id string
合同包ID
end_time date-time
订单结束时间
auto_convert_postpaid boolean
预付费自动转后付费
deleted boolean
是否删除存储卷资源
create_time date-time
创建存储卷资源资源的时间
update_time date-time
上一次更新VirtualVolume resource的时间
]
next_page_token string

下一页的token

total_size int32

存储卷资源总数

{
  "virtual_volumes": [
    {
      "id": "string",
      "name": "string",
      "display_name": "string",
      "description": "string",
      "uid": "string",
      "resource_type": "string",
      "creator_id": "string",
      "owner_id": "string",
      "tenant_id": "string",
      "zone": "string",
      "state": "CREATING",
      "sku_id": "string",
      "tags": {},
      "properties": {
        "resources": {
          "billing_items": {
            "capacity": 0,
            "capacity_unit": "EB"
          }
        }
      },
      "order_info": {
        "billing_cycle_number": 0,
        "auto_renew": true,
        "currency_code": "string",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "string",
        "order_type": "OT_UNSPECIFIED",
        "order_id": "string",
        "start_time": "2025-10-22T08:00:45.281Z",
        "payment_model": "PM_UNSPECIFIED",
        "billing_model": "BM_UNSPECIFIED",
        "original_id": "string",
        "end_time": "2025-10-22T08:00:45.281Z",
        "auto_convert_postpaid": true
      },
      "deleted": true,
      "create_time": "2025-10-22T08:00:45.281Z",
      "update_time": "2025-10-22T08:00:45.281Z"
    }
  ],
  "next_page_token": "string",
  "total_size": 0
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...