获取块存储云盘资源 | 大装置帮助中心
跳到主要内容

获取块存储云盘资源

接口描述​

GET /storage/abs/v1/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/disks/{disk_name}

请求头（Request Header）​

参考认证（authentication）

请求参数（Request Parameters）​

名称类型必须位置默认值取值范围描述
subscription_namestring是path--订阅标识
resource_group_namestring是path--资源组标识
zonestring是path--可用区
disk_namestring是path-^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$块资源名称

请求体（Request Body）​

无

请求示例（Request Example）​

curl --request GET 'https://management.sensecoreapi.dev/storage/abs/v1/subscriptions/e995c396-83f6-4a1b-a055-2acb8bc7cf1f/resourceGroups/default/zones/cn-sh-01e/disks/c6d8b27b-55b7-4ca3-992d-7f369e5076cb'\
  -H 'authority: management.sensecoreapi.dev' \
  -H 'content-type: application/json' \
  -H 'Authorization: xxx'

响应参数（Response Parameters）​

名称类型描述
idstring资源ID
ridstring资源url ID
namestring资源名称
display_namestring资源别名
subscription_namestring订阅名称
resource_group_namestring资源组名称
descriptionstring资源描述信息
uidstring资源实例UUID
typestring资源类型
creator_idstring创建者标识
owner_idstring拥有者标识
tenant_idstring租户标识
zonestring可用区
statestring资源状态
sku_idstring云管sku_id
tagsmap资源标签map<string, string>
propertiesobject资源属性
order_infoobject订单信息
deletedbool是否删除资源
create_timestring资源创建时间
update_timestring资源最新更新时间

请求体中state的值，自定义 State类型，是enum类型，有以下不同含义值:​

状态值状态含义
0CREATING创建中（瞬时状态）
1UPDATING更新中（瞬时状态）
2ACTIVE正常
3DELETING删除中（瞬时状态）
4DELETED已删除
5FAILED操作失败（不保存）
6EXPIREDOWNGRADING到期降级进入宽限期中（瞬时状态）
7EXPIREDOWNGRADED已降级宽限期
8RENEWUPGRADING宽限期续订恢复中（瞬时状态）
9EXPIRESTOPPING到期停服进入保留期中（瞬时状态）
10EXPIRESTOPPED已停服保留期
11RENEWSTARTING保留期续费恢复中（瞬时状态）
12DOWNGRADING服务降级变更中（瞬时状态）
13DOWNGRADE服务已经降级
14RESTORING服务降级恢复中（瞬时状态）
15ATTACHING挂载中
16INUSE使用中
17DETACHING卸载中
18DETACHFAILED卸载失败
19ATTACHFAILED挂载失败
20DELETEDFAILED删除失败
21RESIZING扩容变更中（瞬时状态）
22RESIZEFAILED扩容失败
23ARREARSTOPPING欠费停服变更中（瞬时状态）
24ARREARSTOPPED已欠费停服
25RECHARGESTARTING充值恢复中（瞬时状态）
26RESIZECANCELING取消扩容变更中（瞬时状态）

响应参数中,properties的字段如下:​

参数名类型必须默认值取值范围描述
resourcesobject是--资源规格属性

请求体中properties内的resources 的参数如下:​

参数名类型必须默认值取值范围描述
billing_itemsobject是--资源计费项
disk_typestring是--云盘类型
system_diskbool是--是否为系统盘（false为数据盘）
ecs_lifecyclebool是--是否随ecs实例释放
snapshot_idbool是--根据指定的快照id进行盘的创建
image_idstring否--根据指定的镜像id进行盘的创建

以上disk_type的值，自定义 DiskCategoryUnit类型，是enum类型，有以下不同含义值:​

类型值类型含义
0CLOUDEFFICIENCY高效云盘
1CLOUDSSDSSD 云盘

以上billing_items 的参数如下:​

参数名类型必须默认值取值范围描述
capacitynumber是--对象存储资源包容量大小
capacity_unitCapacityUnit是--资源包容量单位

以上capacity的值，自定义 CapacityUnit 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0EBEB
1PBPB
2TBTB
3GB千兆字节
4MB兆字节

请求体中,order_info的参数如下:​

参数名类型必须默认值取值范围描述
billing_cycle_numbernumber是--购买时长
auto_renewbool否--自动续费
currency_codestring是--货币代码
payment_channelPaymentChannel是--支付方式
notestring否--订单备注
order_typeOrderType是--订单类型
order_idstring是--订单id
start_timestring是--订单生效日期
payment_modelPaymentModel是--付费类型
billing_modelBillingModel是--计费类型
original_idstring否--合同包ID(专有云订单使用)
end_timestring是--订单结束时间
auto_convert_postpaidbool否--预付费自动转后付费

以上payment_channel的值，自定义 PaymentChannel 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0PC_UNSPECIFIED未指定
1PC_BALANCE余额支付
2PC_CREDIT信用支付
3PC_FROZENACCOUNT冻结款支付
4PC_REMIT_OFFLINE线下汇款
5PC_ALIPAY支付宝支付
6PC_UNIONPAY银联支付
7PC_REMIT_ONLINE在线转账
8PC_CONTRACT合同包支付

以上order_type的值，自定义 OrderType 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0OT_UNSPECIFIED未指定
1OT_ORIGINAL原始订单
2OT_RENEW续费订单
3OT_UPGRADED升配订单
4OT_DOWNGRADED降配订单
5OT_CONTRACT合同订单
6OT_UNSUBSCRIBE退订订单
7OT_RESIZE扩缩容订单

以上payment_model的值，自定义 PaymentModel 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0PM_UNSPECIFIED未指定
1PM_PREPAID预付费
2PM_POSTPAID后付费

以上billing_model的值，自定义 BillingModel 类型，是enum类型，有以下不同含义值:​

单位值单位含义
0BM_UNSPECIFIED未指定
1BM_USAGE按量计费
2BM_MONTHLY包月
3BM_YEARLY包年

响应示例（Response Example）​

{
    "id": "2330e95e-6681-11ef-9e0a-523e95af74a9",
    "rid": "/subscriptions/e995c396-83f6-4a1b-a055-2acb8bc7cf1f/resourceGroups/default/zones/cn-sh-01e/disks/c6d8b27b-55b7-4ca3-992d-7f369e5076cb",
    "name": "c6d8b27b-55b7-4ca3-992d-7f369e5076cb",
    "display_name": "0830自测",
    "type": "storage.abs.v1.disk",
    "state": "ACTIVE",
    "zone": "cn-sh-01e",
    "properties": "{\"resources\": {\"image_id\": \"\", \"disk_type\": \"CLOUDSSD\", \"snapshot_id\": \"\", \"system_disk\": false, \"billing_items\": {\"capacity\": 20, \"capacity_unit\": \"GB\"}, \"ecs_lifecycle\": false}}",
    "sku_id": "3583abdc-f096-4b82-a0ff-15a13a7b5c1c",
    "subscription_name": "e995c396-83f6-4a1b-a055-2acb8bc7cf1f",
    "resource_group_name": "default",
    "resource_group_id": "5acd1f6c-5b51-4176-ac52-30aa7faefa6f",
    "resource_group_display_name": "共享资源组",
    "resource_group_rid": "/subscriptions/e995c396-83f6-4a1b-a055-2acb8bc7cf1f/resourceGroups/default",
    "creator_id": "",
    "owner_id": "57463cd8-3ee9-4bf4-b139-8890fd26c914",
    "order_info": {
        "billing_cycle_number": 1,
        "auto_renew": false,
        "currency_code": "CNY",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "",
        "order_type": "OT_ORIGINAL",
        "order_id": "141c2091410124043829248",
        "start_time": "2024-08-30T03:37:09Z",
        "payment_model": "PM_PREPAID",
        "billing_model": "BM_MONTHLY",
        "original_id": "",
        "end_time": "2024-09-30T15:59:59Z",
        "auto_convert_postpaid": false
    },
    "deleted": false,
    "create_time": "2024-08-30T03:37:54.844913Z",
    "update_time": "2024-08-30T03:37:55.315584Z",
    "subscription_display_name": "共享订阅",
    "subscription_id": "",
    "description": ""
}