使用CreateTransitRouterMulticastDomain建立組播域-雲企業網-阿里雲 - Cloud Enterprise Network

群播網域是在地域範圍內定義一個群播網路的範圍，只有群播網域之內的資源可以傳送和接收群播流量，群播網域之外的資源無法傳送和接收群播流量，您可以呼叫 CreateTransitRouterMulticastDomain 介面建立群播網域。

介面說明

在呼叫本介面前，請先了解以下資訊：

請確保您已經在待建立群播網路的地域建立了企業版轉發路由器，並開啟了企業版轉發路由器的群播功能。具體操作，請參見 CreateTransitRouter 。

如果您在申請群播資源前已建立了企業版轉發路由器執行個體，則該企業版轉發路由器執行個體不支援開啟群播功能，您可以刪除目前企業版轉發路由器執行個體，重新建立。如何刪除企業版轉發路由器執行個體，請參見 DeleteTransitRouter 。
在呼叫 CreateTransitRouterMulticastDomain 介面的過程中，如果您指定了 CenId、RegionId 參數的值，則無需指定 TransitRouterId 參數的值；如果您指定了 TransitRouterId 參數的值，則無需指定 CenId 和 RegionId 參數的值。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:CreateTransitRouterMulticastDomain

create

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/*

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。	123e4567-e89b-12d3-a456-4266****
CenId	string	否	雲企業網執行個體 ID。	cen-a7syd349kne38g****
TransitRouterId	string	否	轉發路由器執行個體 ID。	tr-p0wr9p28r92d598y6****
RegionId	string	否	轉發路由器執行個體所屬的地域 ID。您可以透過呼叫 DescribeChildInstanceRegions 介面取得地域 ID。	cn-hangzhou
TransitRouterMulticastDomainName	string	否	群播網域的名稱。名稱可以為空或長度為 1～128 個字元，不能以 http:// 或 https:// 開頭。	nametest
TransitRouterMulticastDomainDescription	string	否	群播網域的描述資訊。描述可以為空或長度為 1～256 個字元，不能以 http:// 或 https:// 開頭。	desctest
DryRun	boolean	否	是否僅預檢此次請求。取值： true：傳送檢查請求，不會建立群播網域。檢查項目包括是否填寫了必要參數、請求格式、業務限制等。如果檢查未通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 `DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後直接建立群播網域。	false
Tag	array<object>	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
	object	否
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空字串。最多支援 64 個字元，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。一次最多支援輸入 20 個標籤的標籤鍵。	TagKey
Value	string	否	資源的標籤值。標籤值可以為空或輸入不超過 128 個字元的字串，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	TagValue
Options	object	否	群播網域功能選項。
Igmpv2Support	string	否	是否為群播網域開啟 IGMP 功能，開啟該功能後主機可以透過網際網路群組管理協定 IGMP（Internet Group Management Protocol）協定動態加入或離開群播群組。取值： enable：開啟 IGMP 功能。 disable（預設值）：未開啟 IGMP 功能。說明 IGMP 功能正在公測中，如需使用，請向客戶經理申請使用權限。 IGMP 功能開啟後不支援關閉。	enable
StrictSourceControl	string	否	是否開啟嚴格群播來源控制功能。如果關閉，則關聯的 VSW 所有 ECS 都可以作為群播來源；如果開啟，則只有靜態設定或者傳送了 IGMP Join 的 ENI 才能作為群播來源。取值： `enable`：開啟嚴格群播來源控制功能。 `disable`：關閉嚴格群播來源控制功能。說明嚴格群播來源控制功能僅對於開啟 IGMP 功能的群播網域生效。目前一個轉發路由器下僅能建立一個關閉了嚴格群播來源控制功能的群播網域。	enable

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
TransitRouterMulticastDomainId	string	群播網域 ID。	tr-mcast-domain-40cwj0rgzgdtam****
RequestId	string	請求 ID。	94E19C6F-206F-5223-9A63-64B85851BC04

樣本

正常返回樣本

JSON格式

{
  "TransitRouterMulticastDomainId": "tr-mcast-domain-40cwj0rgzgdtam****",
  "RequestId": "94E19C6F-206F-5223-9A63-64B85851BC04"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidTransitRouterId.NotFound	The specified TransitRouterId is not found.	參數中指定的 TransitRouterId 不存在。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is illegal.	參數 TransitRouterId 或 RegionId 無效。
400	IllegalParam.CenId	The specified CenId is illegal.	指定的 cenId 不合法。
400	IllegalParam.RegionId	The specified RegionId is illegal.	參數中指定的 Region 無效。
400	InvalidCenId.NotFound	The specified CenId is not found.	參數中指定的 CenId 不存在。
400	InvalidOperation.TransitRouterNotExist	Operation is invalid because the transit router not exist.	轉發路由器不存在。
400	InvalidOperation.CENInstanceStatus	The CEN instance is not in a valid state for the operation.
400	IncorrectStatus.TransitRouterInstance	The status of TransitRouter is incorrect.	轉送路由器狀態不正確。
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.	當前 TransitRouter 類型不支援該操作。
400	OperationUnsupported.ServiceMode	The specified ServiceMode does not support the operation.	目前轉發路由器模式不支援此操作。
400	OperationUnsupported.TransitRouterSupportMulticast	The specified TransitRouterSupportMulticast does not support the operation.
400	OperationUnsupported.RegionId	The specified RegionId does not support the operation.	目前區域不支援此操作。
400	IncorrectStatus.Cen	The status of Cen is incorrect.	當前 CEN 的狀態不支援該操作，請稍後重試。
400	IncorrectStatus.TransitRouter	The status of TransitRouter is incorrect.	目前 TR 的狀態不支援此操作，請稍後重試。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun 請求驗證通過。
400	QuotaExceeded.MulticastDomain	The MulticastDomain quota is exceeded.	群播域的數量超過限制，無法再增加。
400	IllegalParam.Igmpv2Support	The specified Igmpv2Support is illegal. Valid values are [enable, disable].	參數 Igmpv2Support 無效，取值範圍：enable、disable。
400	OperationUnsupported.Igmpv2Support	The current UID does not allow the creation of a igmpv2 multicast domain. Please submit a ticket.	目前的 UID 不允許建立 igmpv2 類型的群播域，請提交工單處理。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	輸入的參數 Tag Value 不合法。

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

變更歷史

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