組播域是在地域范圍內定義一個組播網絡的范圍,只有組播域之內的資源可以發送和接收組播流量,組播域之外的資源無法發送和接收組播流量,您可以調用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 | 否 | 是否只預檢此次請求。取值:
| false |
Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
object | 否 | |||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
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. | cen當前狀態不支持該操作,請稍后重試。 |
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. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-01-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |