获取卷实例列表

GET /storage/afs/v2/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/virtualVolumes

请求头（Request Header）

参考认证（authentication）

请求参数（Request Parameters

名称	类型	必须	位置	默认值	取值范围	描述
subscription_name	string	是	path	-	-	订阅名称.
resource_group_name	string	是	path	-	-	资源组.
zone	string	是	path	-	-	可用区.
filter	string	否	query	-	-	过滤条件.
order_by	string	否	query	-	-	排序,例:"create_time desc, name".
page_size	integer	否	query	-	-	返回当前页的最大条目数.
page_token	string	否	query	-	-	从上一个List请求返回的next_page_token值(如果有的话).

请求示例（Request Example）

curl --location 'https://management.sensecoreapi.tech/storage/afs/v2/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default/zones/cn-sh-01a/virtualVolumes?page_size=100' \
--header 'Accept-Language: zh-CN'

响应（Response）

名称	类型	描述
virtual_volumes	array[object]	卷实例资源详情列表.
next_page_token	string	下一页的token.
total_size	integer	卷实例资源总数.

其中，virtual_volumes的参数如下

名称	类型	描述
id	string	卷实例资源id.
name	string	卷实例资源名称，需符合正则：^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
display_name	string	卷实例资源别名.
description	string	卷实例资源描述.
uid	string	卷实例资源uuid.
resource_type	string	卷实例资源类型, 例子: storage.afs.v2.volume.
creator_id	string	卷实例创建用户id.
owner_id	string	卷实例所有者id.
tenant_id	string	租户id.
zone	string	可用区.
state	string	卷实例状态.
sku_id	string	最小库存单元id.
tags	object	卷实例资源标签.
properties	object	卷实例规格属性.
order_info	object	订单信息.
deleted	boolean	卷实例资源是否删除.
create_time	string	卷实例资源创建时间.
update_time	string	卷实例资源更新时间.

其中，state有如下情况

状态	含义
CREATING	创建中(默认值)
UPDATING	更新中
ACTIVE	已激活
DELETING	删除中
DELETED	已删除
FAILED	失败
EXPIREDOWNGRADING	到期降级中
EXPIREDOWNGRADED	到期已降级
RENEWUPGRADING	续订升级中
EXPIRESTOPPING	到期停服中
EXPIRESTOPPED	到期已停服
RENEWSTARTING	续订恢复中
DOWNGRADING	服务降级中
DOWNGRADE	服务降级
RESTORING	服务降级恢复中

其中，properties的参数如下

名称	类型	描述
resources	object	规格属性.

其中，resources的参数如下

名称	类型	必须	默认值	取值范围	描述
billing_items	string	否	-	-	计费项.

其中，billing_items的参数如下

名称	类型	必须	默认值	取值范围	描述
capacity	string	否	-	-	资源容量.
capacity_unit	string	否	-	-	资源容量单位.

其中，order_info的参数如下

名称	类型	描述
billing_cycle_number	integer	购买时长.
auto_renew	boolean	自动续费.
currency_code	string	货币代码.
payment_channel	string	支付方式.
note	string	订单备注.
order_type	string	订单类型.
order_id	string	订单id.
start_time	string	订单生效日期.
payment_model	string	付费类型.
billing_model	string	计费类型.
original_id	string	合同包ID.
end_time	string	订单结束时间.

其中，payment_channel有如下情况

状态	含义
PC_UNSPECIFIED	未指定
PC_BALANCE	余额支付
PC_CREDIT	信用支付
PC_FROZENACCOUNT	冻结款支付
PC_REMIT_OFFLINE	线下汇款
PC_ALIPAY	支付宝支付
PC_UNIONPAY	银联支付
PC_REMIT_ONLINE	在线转账
PC_CONTRACT	合同包支付

其中，order_type有如下情况

状态	含义
OT_UNSPECIFIED	未指定
OT_ORIGINAL	原始订单
OT_RENEW	续费订单
OT_UPGRADED	升配订单
OT_DOWNGRADED	降配订单
OT_CONTRACT	合同订单
OT_UNSUBSCRIBE	退订订单
OT_RESIZE	扩缩容订单

其中，payment_model有如下情况

状态	含义
PM_UNSPECIFIED	未指定
PM_PREPAID	预付
PM_POSTPAID	后付费

其中，billing_model有如下情况

状态	含义
BM_UNSPECIFIED	未指定
BM_USAGE	按量计费
BM_MONTHLY	包月
BM_YEARLY	包年

响应示例（Response Example）

{
  "virtual_volumes": [
    {
      "id": "/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default/zones/cn-sh-01a/virtualVolumes/f35ce15a-ab79-11ed-b7e4-1070fdcf78e9",
      "name": "f35ce15a-ab79-11ed-b7e4-1070fdcf78e9",
      "display_name": "AcreatePermission_test1",
      "description": "",
      "uid": "f3682bc7-ab79-11ed-906f-7612dd4f00de",
      "resource_type": "storage.afs.v2.volume",
      "creator_id": "76e1a9fa-c5c9-49b7-b42d-c4944cbe8630",
      "owner_id": "76e1a9fa-c5c9-49b7-b42d-c4944cbe8630",
      "tenant_id": "c28f173a-8f18-474c-866b-4ce89a612958",
      "zone": "cn-sh-01a",
      "state": "DELETED",
      "sku_id": "de6c091b-4841-4602-b120-623ee620c8be",
      "tags": {},
      "properties": {
        "resources": {
          "billing_items": {
            "capacity": 10,
            "capacity_unit": "GB"
          }
        }
      },
      "order_info": {
        "billing_cycle_number": 1,
        "auto_renew": false,
        "currency_code": "CNY",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "",
        "order_type": "OT_ORIGINAL",
        "order_id": "30be1887099486319280129",
        "start_time": "2023-02-13T08:39:38Z",
        "payment_model": "PM_PREPAID",
        "billing_model": "BM_MONTHLY",
        "original_id": "",
        "end_time": "2023-03-13T23:59:59Z",
        "auto_convert_postpaid": false
      },
      "deleted": true,
      "create_time": "2023-02-13T08:39:38.554288Z",
      "update_time": "2023-02-13T08:39:38.554288Z"
    },
    {
      "id": "/subscriptions/c28f173a-8f18-474c-866b-4ce89a612958/resourceGroups/default/zones/cn-sh-01a/virtualVolumes/f53ded02-ab79-11ed-b7e4-1070fdcf78e9",
      "name": "f53ded02-ab79-11ed-b7e4-1070fdcf78e9",
      "display_name": "AcreatePermission_test2",
      "description": "",
      "uid": "f548fc4d-ab79-11ed-906f-7612dd4f00de",
      "resource_type": "storage.afs.v2.volume",
      "creator_id": "76e1a9fa-c5c9-49b7-b42d-c4944cbe8630",
      "owner_id": "76e1a9fa-c5c9-49b7-b42d-c4944cbe8630",
      "tenant_id": "c28f173a-8f18-474c-866b-4ce89a612958",
      "zone": "cn-sh-01a",
      "state": "DELETED",
      "sku_id": "de6c091b-4841-4602-b120-623ee620c8be",
      "tags": {},
      "properties": {
        "resources": {
          "billing_items": {
            "capacity": 10,
            "capacity_unit": "GB"
          }
        }
      },
      "order_info": {
        "billing_cycle_number": 1,
        "auto_renew": false,
        "currency_code": "CNY",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "",
        "order_type": "OT_ORIGINAL",
        "order_id": "30be1887099499534516225",
        "start_time": "2023-02-13T08:39:41Z",
        "payment_model": "PM_PREPAID",
        "billing_model": "BM_MONTHLY",
        "original_id": "",
        "end_time": "2023-03-13T23:59:59Z",
        "auto_convert_postpaid": false
      },
      "deleted": true,
      "create_time": "2023-02-13T08:39:41.482396Z",
      "update_time": "2023-02-13T08:39:41.482396Z"
    }
  ],
  "next_page_token": "",
  "total_size": 1309
}