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

创建块存储云盘资源

接口描述​

POST /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）​

参数名类型必须默认值取值范围描述
namestring否--资源名称（同disk_name）
display_namestring是--资源别名
resource_typestring是storage.abs.v1.disk-资源类型
zonestring否--可用区
sku_idstring是--云管sku_id
propertiesobject是--资源属性
order_infoobject是--订单信息

请求体中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_typeDiskCategoryUnit是CLOUDSSD-云盘类型
system_diskbool否false-是否为系统盘（false为数据盘）
ecs_lifecyclebool否false-是否随ecs实例释放
snapshot_idstring否--根据指定的快照id进行盘的创建
image_idstring否--根据指定的镜像id进行盘的创建

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

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

以上billing_items 的参数如下:​

参数名类型必须默认值取值范围描述
capacitynumber是20-云盘资源容量大小
capacity_unitCapacityUnit是GB-容量单位

以上 CapacityUnit为自定义的单位值，是enum类型，有以下不同含义值（注：块存储资源默认使用单位 GB，其他单位值暂不使用）：​

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

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

参数名类型必须默认值取值范围描述
billing_cycle_numbernumber是1-购买时长
auto_renewbool否false-自动续费
currency_codestring是CNY-货币代码
payment_channelPaymentChannel是PC_BALANCE-支付方式
notestring否--订单备注
order_typeOrderType是OT_ORIGINAL-订单类型
order_idstring是--订单id
start_timestring是--订单生效日期
payment_modelPaymentModel是PM_PREPAID-付费类型
billing_modelBillingModel是BM_MONTHLY-计费类型
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包年

请求示例（Request Example）​

curl --request POST '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 'accept: application/json' \
  -H 'accept-language: zh-CN' \
  -H 'authorization: xxxxx'\
  -d '{
    "display_name": "0830自测",
    "resource_type": "storage.abs.v1.disk",
    "zone": "cn-sh-01e",
    "sku_id": "3583abdc-f096-4b82-a0ff-15a13a7b5c1c",
    "properties": {
        "resources": {
            "billing_items": {
                "capacity": 20,
                "capacity_unit": "GB"
            },
            "disk_type": "CLOUDSSD"
        }
    },
    "order_info": {
        "billing_cycle_number": 1,
        "auto_renew": false,
        "currency_code": "CNY",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "",
        "order_type": "OT_ORIGINAL",
        "start_time": "2024-08-30T11:37:09+08:00",
        "payment_model": "PM_PREPAID",
        "billing_model": "BM_MONTHLY"
    }
  }'

响应参数（Response Parameters）​

名称类型描述
display_namestring资源别名
uidstring资源实例UUID
resource_typestring资源类型
zonestring可用区
sku_idstring云管sku_id
propertiesobject资源属性
order_infoobject订单信息

响应示例（Response Example）​

{
    "id": "/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自测",
    "description": "",
    "uid": "2330e95e-6681-11ef-9e0a-523e95af74a9",
    "resource_type": "storage.abs.v1.disk",
    "creator_id": "57463cd8-3ee9-4bf4-b139-8890fd26c914",
    "owner_id": "57463cd8-3ee9-4bf4-b139-8890fd26c914",
    "tenant_id": "e995c396-83f6-4a1b-a055-2acb8bc7cf1f",
    "zone": "cn-sh-01e",
    "state": "CREATING",
    "sku_id": "3583abdc-f096-4b82-a0ff-15a13a7b5c1c",
    "tags": {},
    "properties": {
        "resources": {
            "billing_items": {
                "capacity": 20,
                "capacity_unit": "GB"
            },
            "disk_type": "CLOUDSSD",
            "system_disk": false,
            "ecs_lifecycle": false,
            "snapshot_id": "",
            "image_id": ""
        }
    },
    "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": null,
        "auto_convert_postpaid": false
    },
    "deleted": false,
    "create_time": null,
    "update_time": null
}