華為云計(jì)算 云知識(shí) 創(chuàng)建云硬盤CreateVolume
創(chuàng)建云硬盤CreateVolume
時(shí)間: 2023-08-22 10:39:31
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

功能介紹

創(chuàng)建按需或包周期 云硬盤 。 在創(chuàng)建包周期云硬盤的場(chǎng)景下：

調(diào)試

您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。

URI

POST /v2.1/{project_id}/cloudvolumes

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

是

String

項(xiàng)目ID。獲取方法請(qǐng)參見"獲取項(xiàng)目ID"。

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

是

String

用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。

X-Client-Token

否

String

請(qǐng)求的冪等標(biāo)識(shí)。該參數(shù)的值由客戶端生成，需要確保不同請(qǐng)求的參數(shù)值唯一，取值為36位的UUID格式字符串，有效期為8小時(shí)。攜帶相同冪等標(biāo)識(shí)的多個(gè)請(qǐng)求，會(huì)認(rèn)為多個(gè)請(qǐng)求為同一個(gè)冪等請(qǐng)求，會(huì)返回相同的響應(yīng)體。
表3 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

bssParam

否

BssParamForCreateVolume object

按需和包周期的擴(kuò)展參數(shù)

volume

是

CreateVolumeOption object

待創(chuàng)建的云硬盤信息

server_id

否

String

創(chuàng)建云硬盤并掛載到目標(biāo)虛擬機(jī)。 創(chuàng)建的云硬盤的計(jì)費(fèi)模式會(huì)與虛擬機(jī)的計(jì)費(fèi)模式保持一致。 目前只支持ECS服務(wù)的虛擬機(jī)，暫不支持BMS的 裸金屬服務(wù)器 。

OS-SCH-HNT:scheduler_hints

否

CreateVolumeSchedulerHints object

云硬盤調(diào)度參數(shù)，可用于指定云硬盤創(chuàng)建到某個(gè)專屬存儲(chǔ)池中
表4 BssParamForCreateVolume

參數(shù)

是否必選

參數(shù)類型

描述

chargingMode

否

String

功能說(shuō)明：計(jì)費(fèi)模式。默認(rèn)值為postPaid。 取值范圍：

  • prePaid：包年包月

  • postPaid：按需

缺省值：postPaid

枚舉值：

  • postPaid

  • prePaid

isAutoPay

否

String

功能說(shuō)明：是否立即支付。chargingMode為PrePaid時(shí)該參數(shù)會(huì)生效。默認(rèn)值為false。 取值范圍：

  • true：立即支付，從帳戶余額中自動(dòng)扣費(fèi)

  • false：不立即支付，創(chuàng)建訂單暫不支付

缺省值：false

枚舉值：

  • true

  • false

isAutoRenew

否

String

功能說(shuō)明：是否自動(dòng)續(xù)訂。chargingMode為prePaid時(shí)該參數(shù)會(huì)生效。默認(rèn)值為false。 取值范圍：

  • true：自動(dòng)續(xù)訂，自動(dòng)續(xù)訂周期與訂購(gòu)周期相同

  • false：不自動(dòng)續(xù)訂

缺省值：false

枚舉值：

  • true

  • false

periodNum

否

Integer

功能說(shuō)明：訂購(gòu)周期數(shù)，chargingMode為prePaid時(shí)該參數(shù)會(huì)生效，并且該參數(shù)為為必選。 取值范圍：

  • periodType為month時(shí)，為[1-9]

  • periodType為year時(shí)，為[1-1]

periodType

否

String

功能說(shuō)明：訂購(gòu)周期單位。chargingMode為prePaid時(shí)該參數(shù)會(huì)生效，并且該參數(shù)為必選。 取值范圍：

  • month：月

  • year：年

枚舉值：

  • month

  • year
表5 CreateVolumeOption

參數(shù)

是否必選

參數(shù)類型

描述

availability_zone

是

String

指定要?jiǎng)?chuàng)建云硬盤的可用區(qū)。

backup_id

否

String

備份ID，從備份創(chuàng)建云硬盤時(shí)為必選。

count

否

Integer

批量創(chuàng)云硬盤的個(gè)數(shù)。如果無(wú)該參數(shù)，表明只創(chuàng)建1個(gè)云硬盤，目前最多支持批量創(chuàng)建100個(gè)。 從備份創(chuàng)建云硬盤時(shí)，不支持批量創(chuàng)建，數(shù)量只能為“1”。

如果發(fā)送請(qǐng)求時(shí)，將參數(shù)值設(shè)置為小數(shù)，則默認(rèn)取小數(shù)點(diǎn)前的整數(shù)。

description

否

String

云硬盤的描述。最大支持255個(gè)字節(jié)。

enterprise_project_id

否

String

企業(yè)項(xiàng)目ID。創(chuàng)建云硬盤時(shí)，給云硬盤綁定企業(yè)項(xiàng)目ID。

imageRef

否

String

鏡像 ID，指定該參數(shù)表示創(chuàng)建云硬盤方式為從鏡像創(chuàng)建云硬盤。

metadata

否

Map<String,String>

創(chuàng)建云硬盤的metadata信息

可選參數(shù)如下:[__system__cmkid]metadata中的加密cmkid字段，與__system__encrypted配合表示需要加密，cmkid長(zhǎng)度固定為36個(gè)字節(jié)。

說(shuō)明：

請(qǐng)求獲取密鑰ID的方法請(qǐng)參考："查詢密鑰列表"。

[__system__encrypted]metadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定該字段時(shí),云硬盤的加密屬性與數(shù)據(jù)源保持一致,如果不是從數(shù)據(jù)源創(chuàng)建的場(chǎng)景,則默認(rèn)不加密。

[full_clone]從快照創(chuàng)建云硬盤時(shí)，如需使用link克隆方式，請(qǐng)指定該字段的值為0。

[hw:passthrough]

  • true表示云硬盤的設(shè)備類型為SCSI類型，即允許ECS操作系統(tǒng)直接訪問底層存儲(chǔ)介質(zhì)。支持SCSI鎖命令。

  • false表示云硬盤的設(shè)備類型為VBD (虛擬塊存儲(chǔ)設(shè)備 , Virtual Block Device)類型，即為默認(rèn)類型，VBD只能支持簡(jiǎn)單的SCSI讀寫命令。

  • 該字段不存在時(shí)，云硬盤默認(rèn)為VBD類型。

multiattach

否

Boolean

是否為共享云硬盤。true為共享盤，false為普通云硬盤。

name

否

String

云硬盤名稱。如果為創(chuàng)建單個(gè)云硬盤，name為云硬盤名稱。最大支持255個(gè)字節(jié)。創(chuàng)建的云硬盤數(shù)量（count字段對(duì)應(yīng)的值）大于1時(shí)，為區(qū)分不同云硬盤，創(chuàng)建過程中系統(tǒng)會(huì)自動(dòng)在名稱后加“-0000”的類似標(biāo)記。例如：volume-0001、volume-0002。最大支持250個(gè)字節(jié)。

size

是

Integer

云硬盤大小，單位為GiB，其限制如下： 系統(tǒng)盤：1GiB-1024GiB 數(shù)據(jù)盤：10GiB-32768GiB 創(chuàng)建空白云硬盤和從 鏡像/快照 創(chuàng)建云硬盤時(shí)，size為必選，且云硬盤大小不能小于 鏡像/快照 大小。 從備份創(chuàng)建云硬盤時(shí)，size為可選，不指定size時(shí)，云硬盤大小和備份大小一致。

snapshot_id

否

String

快照ID，指定該參數(shù)表示創(chuàng)建云硬盤方式為從快照創(chuàng)建云硬盤。

volume_type

是

String

云硬盤類型。目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"，"ESSD2"七種。- "SATA"為普通IO云硬盤(已售罄)- "SAS"為高IO云硬盤- "GPSSD"為通用型SSD云硬盤- "SSD"為超高IO云硬盤- "ESSD"為極速IO云硬盤- "GPSSD2"為通用型SSD V2云硬盤- "ESSD2"為極速型SSD V2云硬盤當(dāng)指定的云硬盤類型在avaliability_zone內(nèi)不存在時(shí)，則創(chuàng)建云硬盤失敗。> 說(shuō)明：> 從快照創(chuàng)建云硬盤時(shí)，volume_type字段必須和快照源云硬盤保持一致。> 了解不同云硬盤類型的詳細(xì)信息，請(qǐng)參見 云硬盤類型及性能介紹。

枚舉值：

  • SATA

  • SAS

  • GPSSD

  • SSD

  • ESSD

  • GPSSD2

  • ESSD2

tags

否

Map<String,String>

云硬盤標(biāo)簽信息。

iops

否

Integer

給云硬盤配置iops，購(gòu)買GPSSD2、ESSD2類型的云硬盤時(shí)必填，其他類型不能設(shè)置。說(shuō)明：1、了解GPSSD2、ESSD2類型的iops大小范圍，請(qǐng)參見 云硬盤類型及性能介紹里面的云硬盤性能數(shù)據(jù)表。2、只支持按需計(jì)費(fèi)。

throughput

否

Integer

給云硬盤配置吞吐量，單位是MiB/s，購(gòu)買GPSSD2類型云盤時(shí)必填，其他類型不能設(shè)置。說(shuō)明：1、了解GPSSD2類型的吞吐量大小范圍，請(qǐng)參見 云硬盤類型及性能介紹里面的云硬盤性能數(shù)據(jù)表。2、只支持按需計(jì)費(fèi)。
表6 CreateVolumeSchedulerHints

參數(shù)

是否必選

參數(shù)類型

描述

dedicated_storage_id

否

String

指定專屬存儲(chǔ)池ID，表示將云硬盤創(chuàng)建在該ID對(duì)應(yīng)的存儲(chǔ)池中。

響應(yīng)參數(shù)

狀態(tài)碼： 202

表7 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

job_id

String

任務(wù)ID，云硬盤為按需計(jì)費(fèi)時(shí)返回該參數(shù)。> > > 如果需要查詢job的狀態(tài)，請(qǐng)參考："查詢job的狀態(tài)"。

order_id

String

訂單ID，云硬盤為包周期計(jì)費(fèi)時(shí)返回該參數(shù)。> 直接在包周期 云服務(wù)器 上新增云硬盤，系統(tǒng)會(huì)自動(dòng)將云硬盤掛載到包周期云服務(wù)器上。該情形下也會(huì)返回該參數(shù)。>> > - 如果您需要支付訂單，請(qǐng)參考：

volume_ids

Array of strings

待創(chuàng)建的云硬盤ID列表。> 說(shuō)明：> 通過云硬盤ID查詢?cè)朴脖P詳情 ，若返回404 可能云硬盤正在創(chuàng)建中或者已經(jīng)創(chuàng)建失敗。> 通過JobId查詢?cè)朴脖P創(chuàng)建任務(wù)是否完成查詢job的狀態(tài)。

狀態(tài)碼： 400

表8 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤信息，具體請(qǐng)參見 error參數(shù)說(shuō)明。
表9 Error

參數(shù)

參數(shù)類型

描述

code

String

出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤碼。錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考錯(cuò)誤碼說(shuō)明。

message

String

出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤消息。

請(qǐng)求示例

創(chuàng)建一個(gè)帶標(biāo)簽的共享云硬盤，云硬盤的類型為普通IO，大小為120GiB，包年計(jì)費(fèi)，從帳戶余額中自動(dòng)扣費(fèi)，且自動(dòng)續(xù)訂。

POST https://{endpoint}/v2.1/{project_id}/cloudvolumes

{
  "volume" : {
    "name" : "test_volume_3",
    "availability_zone" : "az1.dc1",
    "volume_type" : "SATA",
    "size" : 120,
    "description" : "test",
    "multiattach" : true,
    "count" : 1,
    "tags" : {
      "key1" : "value1",
      "key2" : "value2"
    }
  },
  "bssParam" : {
    "chargingMode" : "prePaid",
    "periodType" : "year",
    "periodNum" : 1,
    "isAutoPay" : "true",
    "isAutoRenew" : "true"
  }
}

響應(yīng)示例

狀態(tài)碼： 202

Accepted

{
  "job_id" : "70a599e0-31e7-49b7-b260-868f441e862b",
  "volume_ids" : [ "e1fa3e72-8c92-4871-9152-bf66fef0afe9" ]
}

狀態(tài)碼： 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

202

Accepted

400

Bad Request

錯(cuò)誤碼

請(qǐng)參見錯(cuò)誤碼。

 

創(chuàng)建云硬盤CreateVolume

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失??！請(qǐng)稍后重試！