功能介紹
創(chuàng)建按需或包周期 云硬盤 。 在創(chuàng)建包周期云硬盤的場景下:
-
如果您需要查看訂單可用的優(yōu)惠券,請參考"查詢訂單可用優(yōu)惠券"
-
如果您需要退訂該包周期資源,請參考“退訂包周期資源”。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
POST /v2.1/{project_id}/cloudvolumes
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。獲取方法請參見"獲取項目ID"。 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值)。 |
|
X-Client-Token |
否 |
String |
請求的冪等標識。該參數(shù)的值由客戶端生成,需要確保不同請求的參數(shù)值唯一,取值為36位的UUID格式字符串,有效期為8小時。攜帶相同冪等標識的多個請求,會認為多個請求為同一個冪等請求,會返回相同的響應體。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
bssParam |
否 |
按需和包周期的擴展參數(shù) |
|
|
volume |
是 |
待創(chuàng)建的云硬盤信息 |
|
|
server_id |
否 |
String |
創(chuàng)建云硬盤并掛載到目標虛擬機。 創(chuàng)建的云硬盤的計費模式會與虛擬機的計費模式保持一致。 目前只支持ECS服務的虛擬機,暫不支持BMS的 裸金屬服務器 。 |
|
OS-SCH-HNT:scheduler_hints |
否 |
云硬盤調(diào)度參數(shù),可用于指定云硬盤創(chuàng)建到某個專屬存儲池中 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
chargingMode |
否 |
String |
功能說明:計費模式。默認值為postPaid。 取值范圍:
缺省值:postPaid 枚舉值:
|
|
isAutoPay |
否 |
String |
功能說明:是否立即支付。chargingMode為PrePaid時該參數(shù)會生效。默認值為false。 取值范圍:
缺省值:false 枚舉值:
|
|
isAutoRenew |
否 |
String |
功能說明:是否自動續(xù)訂。chargingMode為prePaid時該參數(shù)會生效。默認值為false。 取值范圍:
缺省值:false 枚舉值:
|
|
periodNum |
否 |
Integer |
功能說明:訂購周期數(shù),chargingMode為prePaid時該參數(shù)會生效,并且該參數(shù)為為必選。 取值范圍:
|
|
periodType |
否 |
String |
功能說明:訂購周期單位。chargingMode為prePaid時該參數(shù)會生效,并且該參數(shù)為必選。 取值范圍:
枚舉值:
|
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
availability_zone |
是 |
String |
指定要創(chuàng)建云硬盤的可用區(qū)。 |
|
backup_id |
否 |
String |
備份ID,從備份創(chuàng)建云硬盤時為必選。 |
|
count |
否 |
Integer |
批量創(chuàng)云硬盤的個數(shù)。如果無該參數(shù),表明只創(chuàng)建1個云硬盤,目前最多支持批量創(chuàng)建100個。 從備份創(chuàng)建云硬盤時,不支持批量創(chuàng)建,數(shù)量只能為“1”。 如果發(fā)送請求時,將參數(shù)值設置為小數(shù),則默認取小數(shù)點前的整數(shù)。 |
|
description |
否 |
String |
云硬盤的描述。最大支持255個字節(jié)。 |
|
enterprise_project_id |
否 |
String |
企業(yè)項目ID。創(chuàng)建云硬盤時,給云硬盤綁定企業(yè)項目ID。 |
|
imageRef |
否 |
String |
鏡像 ID,指定該參數(shù)表示創(chuàng)建云硬盤方式為從鏡像創(chuàng)建云硬盤。 |
|
metadata |
否 |
Map<String,String> |
創(chuàng)建云硬盤的metadata信息 可選參數(shù)如下:[__system__cmkid]metadata中的加密cmkid字段,與__system__encrypted配合表示需要加密,cmkid長度固定為36個字節(jié)。 說明:
請求獲取密鑰ID的方法請參考:"查詢密鑰列表"。 [__system__encrypted]metadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定該字段時,云硬盤的加密屬性與數(shù)據(jù)源保持一致,如果不是從數(shù)據(jù)源創(chuàng)建的場景,則默認不加密。 [full_clone]從快照創(chuàng)建云硬盤時,如需使用link克隆方式,請指定該字段的值為0。 [hw:passthrough]
|
|
multiattach |
否 |
Boolean |
是否為共享云硬盤。true為共享盤,false為普通云硬盤。 |
|
name |
否 |
String |
云硬盤名稱。如果為創(chuàng)建單個云硬盤,name為云硬盤名稱。最大支持255個字節(jié)。創(chuàng)建的云硬盤數(shù)量(count字段對應的值)大于1時,為區(qū)分不同云硬盤,創(chuàng)建過程中系統(tǒng)會自動在名稱后加“-0000”的類似標記。例如:volume-0001、volume-0002。最大支持250個字節(jié)。 |
|
size |
是 |
Integer |
云硬盤大小,單位為GiB,其限制如下: 系統(tǒng)盤:1GiB-1024GiB 數(shù)據(jù)盤:10GiB-32768GiB 創(chuàng)建空白云硬盤和從 鏡像/快照 創(chuàng)建云硬盤時,size為必選,且云硬盤大小不能小于 鏡像/快照 大小。 從備份創(chuàng)建云硬盤時,size為可選,不指定size時,云硬盤大小和備份大小一致。 |
|
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云硬盤當指定的云硬盤類型在avaliability_zone內(nèi)不存在時,則創(chuàng)建云硬盤失敗。> 說明:> 從快照創(chuàng)建云硬盤時,volume_type字段必須和快照源云硬盤保持一致。> 了解不同云硬盤類型的詳細信息,請參見 云硬盤類型及性能介紹。 枚舉值:
|
|
tags |
否 |
Map<String,String> |
云硬盤標簽信息。 |
|
iops |
否 |
Integer |
給云硬盤配置iops,購買GPSSD2、ESSD2類型的云硬盤時必填,其他類型不能設置。說明:1、了解GPSSD2、ESSD2類型的iops大小范圍,請參見 云硬盤類型及性能介紹里面的云硬盤性能數(shù)據(jù)表。2、只支持按需計費。 |
|
throughput |
否 |
Integer |
給云硬盤配置吞吐量,單位是MiB/s,購買GPSSD2類型云盤時必填,其他類型不能設置。說明:1、了解GPSSD2類型的吞吐量大小范圍,請參見 云硬盤類型及性能介紹里面的云硬盤性能數(shù)據(jù)表。2、只支持按需計費。 |
響應參數(shù)
狀態(tài)碼: 202
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
job_id |
String |
任務ID,云硬盤為按需計費時返回該參數(shù)。> > > 如果需要查詢job的狀態(tài),請參考:"查詢job的狀態(tài)"。 |
|
order_id |
String |
訂單ID,云硬盤為包周期計費時返回該參數(shù)。> 直接在包周期 云服務器 上新增云硬盤,系統(tǒng)會自動將云硬盤掛載到包周期云服務器上。該情形下也會返回該參數(shù)。>> > - 如果您需要支付訂單,請參考: |
|
volume_ids |
Array of strings |
待創(chuàng)建的云硬盤ID列表。> 說明:> 通過云硬盤ID查詢云硬盤詳情 ,若返回404 可能云硬盤正在創(chuàng)建中或者已經(jīng)創(chuàng)建失敗。> 通過JobId查詢云硬盤創(chuàng)建任務是否完成查詢job的狀態(tài)。 |
狀態(tài)碼: 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error |
出現(xiàn)錯誤時,返回的錯誤信息,具體請參見 error參數(shù)說明。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
code |
String |
出現(xiàn)錯誤時,返回的錯誤碼。錯誤碼和其對應的含義請參考錯誤碼說明。 |
|
message |
String |
出現(xiàn)錯誤時,返回的錯誤消息。 |
請求示例
創(chuàng)建一個帶標簽的共享云硬盤,云硬盤的類型為普通IO,大小為120GiB,包年計費,從帳戶余額中自動扣費,且自動續(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"
}
}
響應示例
狀態(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 |
錯誤碼
請參見錯誤碼。
