組播域是在地區範圍內定義一個組播網路的範圍,只有組播域之內的資源可以傳送接收群組播流量,組播域之外的資源無法傳送接收群組播流量,您可以調用CreateTransitRouterMulticastDomain介面建立組播域。
介面說明
在調用本介面前,請先瞭解以下資訊:
-
請確保您已經在待建立組播網路的地區建立了企業版轉寄路由器,並開啟了企業版轉寄路由器的組播功能。具體操作,請參見 CreateTransitRouter 。
如果您在申請組播資源前已建立了企業版轉寄路由器執行個體,則該企業版轉寄路由器執行個體不支援開啟組播功能,您可以刪除當前企業版轉寄路由器執行個體,重新建立。如何刪除企業版轉寄路由器執行個體,請參見 DeleteTransitRouter 。
-
在調用 CreateTransitRouterMulticastDomain 介面的過程中,如果您指定了 CenId、RegionId 參數的值,則無需指定 TransitRouterId 參數的值;如果您指定了 TransitRouterId 參數的值,則無需指定 CenId 和 RegionId 參數的值。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cen:CreateTransitRouterMulticastDomain |
create |
TransitRouter
*TransitRouterMulticastDomain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
否 |
是否只預檢此次請求。取值:
|
false |
| Tag |
array<object> |
否 |
標籤資訊。 一次最多支援輸入 20 個標籤資訊。 |
|
|
object |
否 |
|||
| Key |
string |
否 |
資源的標籤鍵。 一旦傳入該值,則不允許為空白字串。最多支援 64 個字元,不能以 一次最多支援輸入 20 個標籤的標籤鍵。 |
TagKey |
| Value |
string |
否 |
資源的標籤值。 標籤值可以為空白或輸入不超過 128 個字元的字串,不能以 每一個標籤鍵對應一個標籤值,一次最多支援輸入 20 個標籤鍵對應的標籤值。 |
TagValue |
| Options |
object |
否 |
組播域功能選項。 |
|
| Igmpv2Support |
string |
否 |
是否為組播域開啟 IGMP 功能,開啟該功能後主機可以通過互連網組管理協議 IGMP(Internet Group Management Protocol)協議動態加入或離開組播組。取值:
說明
|
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不合法。 |
| 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. | 當前TransitRouter的狀態不支援該操作,請稍後重試。 |
| 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. | 帳號無許可權操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。