調用CreateDesktopGroup建立共用型雲電腦-無影雲電腦企業版-阿里雲

建立共用型雲電腦。

介面說明

關於共用型雲電腦的功能和應用情境、使用限制、伸縮策略等資訊，請參見共用型雲電腦（原雲電腦池）概述。
調用本介面之前，請確保已建立辦公網路、雲電腦模板、策略等必需的前置資源。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。可以調用 DescribeRegions 擷取無影雲電腦支援的地區列表。	cn-hangzhou
BundleId	string	否	雲電腦模板 ID。	b-je9hani001wfn****
OfficeSiteId	string	是	共用型雲電腦所屬的辦公網路識別碼。	cn-hangzhou+os-c5cy7q578s8jc****
PolicyGroupId	string	是	共用型雲電腦關聯的策略 ID。	pg-9c2d6t2dwflqr****
DesktopGroupName	string	否	共用型雲電腦名稱。不超過 30 個字元。必須以大小字母或中文開頭，不能以`http://`和`https://`開頭。可以包含中文、英文、數字、半形冒號（:）、底線（_）、點號（.）或者短劃線（-）。	SharedComputers01
DirectoryId	string	否	目錄 ID。說明該參數暫未開放使用。	dri-uf62w3qzt4aigvlcb****
ScaleStrategyId	string	否	伸縮策略 ID。說明該參數暫未開放使用。	ss-f9dkjz6vw3aaw****
VpcId	string	否	共用型雲電腦的辦公網路所在的 VPC ID。說明該參數暫未開放使用。	vpc-uf6w8u60n8xbkg5el****
DefaultInitDesktopCount	integer	否	建立多台共用型雲電腦時預設建立的雲電腦數量。預設值為 1。	1
KeepDuration	integer	否	會話中斷連線後繼續保留的時間。單位為毫秒，取值範圍為 180000（3 分鐘）~345600000（4 天）。取值為 0 時，表示始終保留。當會話因為使用者主動斷開或因為其他因素意外斷開時，從斷開的時刻開始計算，若在該保留時間長度內使用者始終未重建立立與該會話的串連，則該會話登出，未儲存的資料都將銷毀；若在該保留時間長度內，使用者重建立立串連成功，則仍可進入原來的會話，仍可訪問對話斷開之前的資料。	180000
ChargeType	string	是	雲電腦的付費類型。枚舉值： PostPaid : 隨用隨付 PrePaid : 訂用帳戶	PrePaid
Period	integer	否	訂用帳戶共用型雲電腦的購買時間長度。當參數`ChargeType`取值為`PrePaid`時才生效，且為必選值。單位由`PeriodUnit`指定。如果`PeriodUnit`為`Month`，該參數的取值範圍： 1 2 3 6 如果`PeriodUnit`為`Year`，該參數的取值範圍： 1 2 3 4 5	1
PeriodUnit	string	否	訂用帳戶計費方式的時間長度單位。枚舉值： Month : 月 Year : 年	Month
OwnType	integer	否	共用型雲電腦類型。說明該參數暫未開放使用。枚舉值： 0 : 個人型（單會話） 1 : 共用型（多會話）	0
AutoPay	boolean	否	是否自動支付訂用帳戶訂單。	true
Comments	string	否	備忘資訊。	comment
MinDesktopsCount	integer	否	訂用帳戶的多台共用型雲電腦的自動建立數量上限。即當參數`ChargeType`取值為`PrePaid`時才生效，且為必選值。預設值為 1，取值範圍為 0~`MaxDesktopsCount`。	1
MaxDesktopsCount	integer	否	隨用隨付的多台共用型雲電腦的最大數量。取值範圍：0~500。	50
AllowAutoSetup	integer	否	是否允許訂用帳戶的多台共用型雲電腦內自動建立雲電腦。即當參數`ChargeType`取值為`PrePaid`時才生效，且為必選值。枚舉值： 0 : 不允許 1 : 允許	1
AllowBufferCount	integer	否	隨用隨付的多台共用型雲電腦內允許預留的雲電腦數量。當參數`ChargeType`取值為`PostPaid`時才生效，且為必選值。取值範圍： 0：不預留 N：預留 N 台（1≤N≤100）說明如果不預留可用雲電腦，當終端使用者發起串連請求時，系統需要先建立並啟動雲電腦，然後分配給使用者，所需時間相對較長。建議您根據需要預留一定數量的雲電腦，保證終端使用者的使用體驗。	1
ClientToken	string	否	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。	123e4567-e89b-12d3-a456-426655440000
EndUserIds	array	否	共用型雲電腦的使用者識別碼列表。
	string	否	共用型雲電腦的使用者識別碼。	alice
ResetType	integer	否	雲電腦重設類型。枚舉值： 0 : 不重設 1 : 只重設系統硬碟 2 : 只重設使用者磁碟 3 : 重設系統硬碟和使用者磁碟	0
LoadPolicy	integer	否	多會話共用型雲電腦的負載平衡策略。說明該參數暫未開放使用。枚舉值： 0 : 深度優先 1 : 廣度優先	0
BindAmount	integer	否	多會話共用型雲電腦中每台雲電腦允許的並發會話數。說明該參數暫未開放使用。	2
Classify	string	否	共用型雲電腦的類型。說明該參數暫未開放使用。枚舉值： teacher : 教師共用型雲電腦 student : 學生共用型雲電腦	teacher
AllClassifyUsers	boolean	否	所有共用型雲電腦分類的使用者。說明該參數暫未開放使用。	Alice
VolumeEncryptionEnabled	boolean	否	是否開啟磁碟加密。	false
VolumeEncryptionKey	string	否	開啟磁碟加密的情況下使用的 KMS 的金鑰識別碼。可通過 ListKeys 介面擷取。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
RatioThreshold	number	否	會話佔用率閾值，用作多會話共用型雲電腦的自動調整觸發條件。會話佔用率的計算公式為： `會話佔用率 = 已綁定會話數 / (雲電腦資源總數 × 每台雲電腦支援的最大會話數) × 100%` 當會話佔用率達到該閾值時，則會建立雲電腦；未達到該閾值時，則刪除多餘的雲電腦。說明該參數暫未開放使用。	0.5
ConnectDuration	integer	否	會話處於串連狀態的最大時間長度。會話串連時間長度達到此值時將自動中斷連線。單位：毫秒。取值範圍：900000（15 分鐘）~345600000（4 天）。	900000
IdleDisconnectDuration	integer	否	使用者會話建立串連後，如果在該最大時間長度內，始終沒有任何鍵盤或滑鼠操作，則該會話中斷連線。單位：毫秒。取值範圍為 360000（6 分鐘）~3600000（60 分鐘）。在達到該時間長度的 30 秒前，會話中的終端使用者將收到儲存文檔資料的提示訊息，此時終端使用者需及時儲存文檔資料，避免丟失。說明僅適用於鏡像版本號碼不低於 1.0.2 的雲電腦。	360000
StopDuration	integer	否	空閑關機時間。當雲電腦空閑時間長度達到該值時，自動關機。關機後如果有使用者串連，會自動開機。單位：毫秒。	300000
ProfileFollowSwitch	boolean	否	是否開啟使用者數據漫遊。說明該參數暫未開放使用。	false
FileSystemId	string	否	使用者數據漫遊功能使用的 NAS 檔案系統 ID。說明該參數暫未開放使用。	kegd-nas-****
BuyDesktopsCount	integer	否	對於訂用帳戶多台共用型雲電腦：初始建立雲電腦的數量。取值範圍：0~200。對於隨用隨付多台共用型雲電腦：初始建立雲電腦的最小數量。預設值為 1，取值範圍為 0~`MaxDesktopsCount`。	3
GroupVersion	integer	否	共用型雲電腦版本。	2
AutoRenew	boolean	否	是否為訂用帳戶共用型雲電腦開啟自動續約。枚舉值： true : 開啟自動續約 false : 不開啟自動續約	false
Tag	array<object>	否	標籤列表，最多包含 20 個子項。
	object	否	標籤。
Key	string	是	標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	TestKey
Value	string	是	標籤值。可以為空白字串。最多支援 128 個字元，不能以`acs:`開頭，不能包含`http://`或者`https://`。	TestValue
PromotionId	string	否	優惠券 ID。	youhuiquan_promotion_option_id_*****
ImageId	string	否	鏡像 ID。	m-gx2x1dhsmusr2****
SystemDiskCategory	string	否	系統硬碟類型。枚舉值： cloud_auto : SSD 極速雲端硬碟 cloud_essd : ESSD 雲端硬碟	cloud_auto
SystemDiskSize	integer	否	系統硬碟大小，單位：GiB。說明系統硬碟大小不能小於鏡像檔案。	80
SystemDiskPerLevel	string	否	ESSD 磁碟效能等級，預設為 PL0。枚舉值： PL1 : PL1 PL0 : PL0	PL0
DataDiskCategory	string	否	資料盤類型。枚舉值： cloud_auto : SSD 極速雲端硬碟 cloud_essd : ESSD 雲端硬碟	cloud_auto
DataDiskSize	integer	否	掛載的資料盤容量大小。單位：GB。取值範圍：0~16380，取值必須是 20 的整數倍。取值為 0 時，表示不掛載資料盤。如果您選擇的套餐使用的是 SSD 雲端硬碟，則掛載的資料盤容量最小值為 20 GB。預設值：0	80
DataDiskPerLevel	string	否	ESSD 磁碟效能等級，預設為 PL0。枚舉值： PL1 : PL1 PL0 : PL0	PL0
DefaultLanguage	string	否	系統語言。枚舉值： en-US : 英語 zh-HK : 繁體中文 zh-CN : 簡體中文 ja-JP : 日語	zh-CN
DesktopType	string	否	雲電腦規格。您可以調用 DescribeDesktopTypes 查詢雲電腦支援的規格 ID。	eds.enterprise_office.16c64g
Hostname	string	否	自訂設定雲電腦的主機名稱。僅支援設定 AD 辦公網路下，作業系統類型是 Windows 的雲電腦。主機名稱的命名規則如下：長度為 2~15 個字元。支援大小寫字母、數字或者短劃線（-）。不能以短劃線開頭或者結尾，不能連續使用短劃線，不能只使用數字。建立多台雲電腦時，可以使用`name_prefix[begin_number,bits]name_suffix`的命名格式為多台雲電腦統一命名。例如，設定 Hostname 的取值為 ecd-[1,4]-test，則第一台雲電腦主機名稱為 ecd-0001-test，第二台雲電腦主機名稱為 ecd-0002-test，依次類推。 `name_prefix`：主機名稱的首碼。 `[begin_number,bits]`：主機名稱中的有序數字。`begin_number`為起始數字，取值支援 0~999999，預設值為 0；`bits`為數字位元，取值支援 1~6，預設值為 6。 `name_suffix`：主機名稱的尾碼。	testhost
MultiResource	boolean	否	是否為多台共用類型的共用型雲電腦。枚舉值： true : 多台共用型雲電腦 false : 單台共用型雲電腦	false
ExclusiveType	string	否	建立靜態池。當參數`SessionType`的值為`MultipleSession`時，必須傳入此參數，值固定填寫為`Exclusive`。	Exclusive
GroupAmount	integer	否	建立單台共用型雲電腦的數量。只有當`MultiResource`參數的值為`false`時才需要傳入該參數。取值範圍：1~5。預設值：1。	1
SessionType	string	否	會話類型。枚舉值： SingleSession : 單會話 MultipleSession : 多會話	SingleSession
TimerGroupId	string	否	定時工作群組 ID。	ccg-0caoeogrk9m5****
SnapshotPolicyId	string	否	自動快照策略 ID。	sp-28mp6my0l6zow****
ResellerOwnerUid	integer	否
UserOuPath	string	否
UserGroupName	string	否
SimpleUserGroupId	string	否
DeleteDuration	integer	否

返回參數

名稱	類型	描述	樣本值
	object	返回資訊集合。
DesktopGroupId	string	共用型雲電腦 ID。	dg-2i8qxpv6t1a03****
RequestId	string	請求 ID。	3EB7FCEE-D731-4948-85A3-4B2C341CA983
OrderIds	array	訂單 ID。
	string	訂單 ID。當請求參數`ChargeType`取值為`PrePaid`時，返回該參數。	123456789
DesktopGroupIds	array	共用型雲電腦 ID 列表。
	string	共用型雲電腦 ID 列表。	['dg-1np2yupx0uim****']

樣本

正常返回樣本

JSON格式

{
  "DesktopGroupId": "dg-2i8qxpv6t1a03****",
  "RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
  "OrderIds": [
    "123456789"
  ],
  "DesktopGroupIds": [
    "['dg-1np2yupx0uim****']"
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。