華為云計算 云知識 購買系統(tǒng)定義網(wǎng)絡(luò)云手機服務(wù)器CreateCloudPhoneServer
購買系統(tǒng)定義網(wǎng)絡(luò)云手機服務(wù)器CreateCloudPhoneServer

 

接口說明

購買系統(tǒng)定義網(wǎng)絡(luò) 云手機 服務(wù)器。

URL
POST  https://cph.ap-southeast-3.myhuaweicloud.com/v1/{project_id}/cloud-phone/phones 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

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

project_id
 
string path

項目id。

Body參數(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
 
Array of Port objects

云手機啟用的應(yīng)用端口,云手機服務(wù)會做端口轉(zhuǎn)發(fā)

band_width
 
band_width object

云手機使用的帶寬信息。獨占帶寬按流量計費,共享帶寬可選擇帶寬大小

extend_param
 
extend_param object

計費模式參數(shù)

vnc_enable
 
string

(已廢棄)是否開啟VNC方式登錄云手機。

  • 為"true"時開啟(忽略大小寫)。
  • 為其他,則不開啟
subnet_cidr
 
string

服務(wù)器的子網(wǎng)信息,第一次購買系統(tǒng)會自動創(chuàng)建172.31.0.0/16的子網(wǎng)。需要自定義子網(wǎng)的客戶,需要全部通過 API購買 ,設(shè)置的子網(wǎng),必須是子網(wǎng)的格式且和已有子網(wǎng)不能重疊

參數(shù):
ports
名稱 類型 必選 描述
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ù):
band_width
名稱 類型 必選 描述
band_width_id
 
string

云手機服務(wù)器的帶寬唯一標識

band_width_size
 
integer

云手機服務(wù)器的帶寬大小

band_width_share_type
 
integer

云手機服務(wù)器的帶寬類型

  • 0,per,獨享帶寬
  • 1,whole,共享帶寬
參數(shù):
extend_param
名稱 類型 必選 描述
charging_mode
 
integer

計費類型 0 表示包周期

period_type
 
integer

訂購周期類型

  • 2 表示月
  • 3 表示年
period_num
 
integer

訂購周期數(shù) 當訂購周期為月時,取值范圍[1, 9]。 當訂購周期為年時,取值范圍[1,10]

is_auto_pay
 
integer

是否自動付款。默認不自動付款。

  • 1 表示自動付款
  • 0 表示不自動付款
is_auto_renew
 
integer

是否自動續(xù)訂。默認不自動續(xù)訂。

  • 1 表示自動續(xù)訂
  • 0 表示不自動續(xù)訂
enterprise_project_id
 
string

企業(yè)項目ID。 該字段不傳(或傳為字符串“0”),則將資源綁定給默認企業(yè)項目。

返回參數(shù)
返回碼: 200

OK

名稱 類型 必選 描述
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列表

請求示例
示例 1

購買系統(tǒng)定義網(wǎng)絡(luò)云手機服務(wù)器

 
"POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones"
 
{ "server_name": "myPhoneServer", "server_model_name": "physical.rx1.xlarge", "phone_model_name": "aphs1.medium.4.aosp", "image_id": "88b8449b896f3a4f0ad57222dd919899", "count": 3, "keypair_name": "mykeypair", "ports": [ { "name": "myServer1", "listen_port": 20000, "internet_accessible": "false" }, { "name": "myServer2", "listen_port": 20001, "internet_accessible": "true" } ], "band_width": { "band_width_share_type": 0 }, "extend_param": { "charging_mode": 0, "period_type": 2, "period_num": 1, "is_auto_pay": 1 } }
返回示例
返回碼:200

OK

示例 1
 
{
"request_id": "1564567b8bab40f34711234cb80d8574",
"order_id": "CS1710111105S8IPB",
"product_id": "00301-25217-0--0",
"server_ids": [
"1234567b8bab40ffb711234cb80d0234",
"1678567b8bab40f93711234cb80d0764"
]
}
SDK
點擊 云手機 (CPH) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明。