功能介紹
購買 云手機 服務(wù)器，支持您復(fù)用已有的VPC網(wǎng)絡(luò)管理云手機服務(wù)器，支持云手機服務(wù)器復(fù)用您已購買的共享帶寬等資源。
-
請確保您已具有 虛擬私有云 資源，創(chuàng)建服務(wù)器需要指定一個已有的虛擬 私有云 ，否則無法創(chuàng)建服務(wù)器。
-
請確保已正確創(chuàng)建委托（委托名稱cph_admin_trust，委托服務(wù)CPH），委托未被刪除， 確保委托包含VPC FullAccess權(quán)限，委托及權(quán)限校驗失敗將導(dǎo)致 云服務(wù)器 創(chuàng)建失敗。創(chuàng)建委托時委托類型選擇“云服務(wù)”，云服務(wù)選擇“CPH”，即允許CPH調(diào)用云服務(wù)。
-
請確保您使用的賬號具有Security Administrator權(quán)限或者具備創(chuàng)建委托的細粒度權(quán)限iam:agencies:createAgency。
-
請確保您有足夠的服務(wù)器及網(wǎng)絡(luò)配額，配額校驗不通過將導(dǎo)致創(chuàng)建失敗。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
POST /v2/{project_id}/cloud-phone/servers
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目id。 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取（響應(yīng)消息頭中X-Subject-Token的值）。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
server_name |
是 |
String |
云手機服務(wù)器名稱，不超過60個字符，只支持英文字母、數(shù)字、漢字、下劃線和中劃線。批量購買會在服務(wù)器名稱后自動添加序號，比如設(shè)置此參數(shù)為server-1，那么創(chuàng)建的云手機服務(wù)器名稱會自動按序增加數(shù)字后綴，比如為server-1-0001。 |
|
server_model_name |
是 |
String |
云手機服務(wù)器規(guī)格，不超過64個字節(jié)。 |
|
phone_model_name |
是 |
String |
云手機規(guī)格，不超過64個字節(jié)。 |
|
image_id |
是 |
String |
云手機 鏡像 ID，不超過32個字節(jié)。 |
|
count |
是 |
Integer |
購買的云手機服務(wù)器個數(shù)，最多可購買10臺。 |
|
keypair_name |
否 |
String |
密鑰對名稱，不超過64個字節(jié)，用于云手機ADB登錄。 |
|
ports |
否 |
云手機啟用的應(yīng)用端口，云手機服務(wù)會做端口轉(zhuǎn)發(fā)。 |
|
|
extend_param |
是 |
計費模式參數(shù)。 |
|
|
tenant_vpc_id |
是 |
String |
租戶自定義的VPC ID，為待創(chuàng)建的云服務(wù)器所屬的虛擬私有云（簡稱VPC），需要指定已創(chuàng)建VPC的ID，UUID格式。 |
|
nics |
是 |
租戶自定義的網(wǎng)卡的結(jié)構(gòu)體，為待創(chuàng)建的云服務(wù)器的網(wǎng)卡信息。 |
|
|
public_ip |
是 |
租戶自定義的 彈性公網(wǎng)IP 結(jié)構(gòu)體。 配置云服務(wù)器的彈性IP信息的方式， 自動分配，需要指定新創(chuàng)建彈性IP的信息； 使用已有，需要指定已經(jīng)購買的EIP ID。 |
|
|
phone_count_per_ip |
否 |
Integer |
多少個手機共用一個vip。默認為手機開數(shù)，表示所有手機共享1個vip。取值范圍：1到手機規(guī)格開數(shù)。 |
|
phone_data_volume |
否 |
手機磁盤結(jié)構(gòu)體，2.0規(guī)格必選。 |
|
|
server_share_data_volume |
否 |
共享存儲磁盤結(jié)構(gòu)體，2.0規(guī)格可選。 |
|
|
band_width |
是 |
云手機使用的帶寬信息。 |
|
|
availability_zone |
否 |
String |
待創(chuàng)建云服務(wù)器所在的可用區(qū)，需要指定可用區(qū)（AZ）的名稱。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
應(yīng)用端口名稱，不超過16個字節(jié)，系統(tǒng)關(guān)鍵服務(wù)名稱不能使用"adb"和"vnc"。 |
|
listen_port |
是 |
Integer |
端口號，大于等于10000，小于等于50000。 |
|
internet_accessible |
是 |
String |
為"true"則映射出公網(wǎng)訪問（忽略大小寫）。 為其他則不映射。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
charging_mode |
是 |
Integer |
計費類型。
|
|
period_type |
是 |
Integer |
訂購周期類型。
|
|
period_num |
是 |
Integer |
訂購周期數(shù)。 當訂購周期為月時，取值范圍[1, 9]。 當訂購周期為年時，取值范圍[1,10]。 |
|
is_auto_pay |
否 |
Integer |
是否自動付款。默認不自動付款。
|
|
is_auto_renew |
否 |
Integer |
是否自動續(xù)訂。默認不自動續(xù)訂。
|
|
enterprise_project_id |
否 |
String |
企業(yè)項目ID。 該字段不傳（或傳為字符串“0”），則將資源綁定給默認企業(yè)項目。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
subnet_id |
是 |
String |
租戶自定義的子網(wǎng) ID，為待創(chuàng)建的云服務(wù)器所屬的子網(wǎng)。 需要指定tenant_vpc_id對應(yīng)VPC下已創(chuàng)建的子網(wǎng)（subnet）的網(wǎng)絡(luò)ID，UUID格式。 |
|
ipv6_enable |
否 |
Boolean |
是否支持ipv6。 取值為true時，標識此網(wǎng)卡支持ipv6。 |
|
ipv6_bandwidth |
否 |
綁定的共享帶寬信息，詳情請參見 ipv6_bandwidth數(shù)據(jù)結(jié)構(gòu)說明。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
ids |
否 |
Array of strings |
指定已有的EIP進行服務(wù)器創(chuàng)建，當前只支持傳入一個已有的EIP ID。 |
|
eip |
否 |
配置服務(wù)器自動分配彈性IP時，創(chuàng)建彈性IP的配置參數(shù)，詳情見 eip 結(jié)構(gòu)體。 |
|
|
count |
否 |
Integer |
Eip數(shù)量。默認為1，不需要Eip可設(shè)置為0，取值范圍為0到手機IP數(shù)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
彈性 公網(wǎng)IP 的類型。
|
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
volume_type |
是 |
String |
磁盤類型，只支持如下類型：
|
|
size |
是 |
Integer |
磁盤大小，單位GB，取值范圍[0，32768]。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
請求的唯一標識ID。 |
|
order_id |
String |
訂單ID，不超過64個字節(jié)。 |
|
product_id |
String |
產(chǎn)品ID，不超過64個字節(jié)。 |
|
server_ids |
Array of strings |
服務(wù)器ID列表。 |
請求示例
購買自定義網(wǎng)絡(luò)服務(wù)器
POST https://{CPH Endpoint}/v2/{project_id}/cloud-phone/servers
{
"server_name" : "cph-kertus-1110",
"server_model_name" : "physical.kg1.4xlarge.cp",
"phone_model_name" : "kg1.cp.c20.d64SSD.e1v1",
"image_id" : "20060220200717f201120a2300000e91",
"count" : 1,
"keypair_name" : "keypair",
"ports" : [ {
"name" : "myServer1",
"listen_port" : 20000,
"internet_accessible" : "false"
}, {
"name" : "myServer2",
"listen_port" : 20001,
"internet_accessible" : "true"
} ],
"extend_param" : {
"charging_mode" : 0,
"period_type" : 2,
"period_num" : 1,
"is_auto_pay" : 0
},
"tenant_vpc_id" : "fca063f6-b942-42a8-9004-e5545f58d6a2",
"nics" : [ {
"subnet_id" : "f1cbfc37-eb42-4357-a0ec-9e4f11950908"
} ],
"public_ip" : {
"eip" : {
"type" : "5_bgp"
}
},
"band_width" : {
"band_width_share_type" : 0,
"band_width_size" : 300,
"band_width_charge_mode" : 1
}
}
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"request_id" : "1564567b8bab40f34711234cb80d8574",
"order_id" : "CS1710111105S8IPB",
"product_id" : "00301-25217-0--0",
"server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
