為了VPC下的資源可以實現組播通信,調用AssociateTransitRouterMulticastDomain接口將專有網絡(VPC)下的交換機(VSwitch)關聯到組播域中。
接口說明
-
一個交換機只支持關聯至一個組播域。請確保待關聯的交換機未與其他組播域建立關聯關系。解除交換機與組播域的關聯關系,請參見 DisassociateTransitRouterMulticastDomain 。
-
AssociateTransitRouterMulticastDomain 接口屬于異步接口,即系統會先返回一個 RequestId,但交換機和組播域并未完全建立關聯關系,系統后臺的關聯任務仍在進行。您可以調用 ListTransitRouterMulticastDomainAssociations 接口查詢交換機和組播域的關聯狀態。
- 當關聯狀態為 Associating 時,表示交換機和組播域正在建立關聯關系,在該狀態下,您只能對交換機執行查詢操作,不能執行其他操作。
- 當關聯狀態為 Associated 時,表示交換機和組播域已成功建立關聯關系。
-
交換機所屬的 VPC 必須已經連接到企業版轉發路由器。創建 VPC 連接,請參見 CreateTransitRouterVpcAttachment 。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:AssociateTransitRouterMulticastDomain | update | *TransitRouterMulticastDomain acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 | 123e4567-e89b-12d3-a456-426655440000 |
TransitRouterMulticastDomainId | string | 是 | 組播域 ID。 | tr-mcast-domain-91wpg6wbhchjeq**** |
TransitRouterAttachmentId | string | 是 | VPC 連接 ID。 | tr-attach-g3kz2k3u76amsk**** |
VSwitchIds | array | 是 | 交換機 ID 列表。 | |
string | 是 | 交換機 ID。 一次最多支持關聯 5 個交換機,一個組播域最多支持關聯 10 個交換機。 | vsw-p0wxk12u6okfkr8xy**** | |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "F88AC12C-943B-50E9-A344-4F8820BB07A7"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidMulticastDomain.NotFound | The specified MulticastDomain is not found. | 參數中指定的MulticastDomain不存在。 |
400 | IncorrectStatus.MulticastDomain | The status of MulticastDomain is incorrect. | 當前MulticastDomain的狀態不支持該操作,請稍后重試。 |
400 | InvalidAttachmentId.NotFound | The specified AttachmentId is not found. | AttachmentId不存在。 |
400 | IllegalParam.AttachmentId | The specified AttachmentId is illegal. | 參數中指定的AttachmentId不合法。 |
400 | IncorrectStatus.Attachment | The status of Attachment is incorrect. | 當前Attachment的狀態不支持該操作,請稍后重試。 |
400 | MissingParam.VSwitchIds | The parameter VSwitchIds is mandatory. | 缺少參數VSwitchIds。 |
400 | InstanceNotExist | The instance is not exist. | 指定實例不存在。 |
400 | OperationUnsupported.CloudBoxVpc | The specified CloudBoxVpc does not support the operation. | 云盒VPC不支持該操作。 |
400 | AssociationExist.VSwitchIds | The association already exists. | Vswitch已綁定。 |
400 | QuotaFull.VswitchPerMulticastDomain | The number of vswitch associated with multicast domain has exceed the maximum value that can be created. | 組播域關聯的vswitch數量已達到上限。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun請求驗證通過。 |
400 | OperationUnsupported.VpcRegion | The specified Region is not support for this operation. | 當前地域不支持該操作。 |
400 | OperationUnsupported.AdvancedFeature | The specified vpc does not support the operation. | - |
400 | QuotaFull.MulticastDomainPerVpc | The number of multicast domain that vpc associated has exceed the maximum value that can be associated. | VPC可以關聯的組播域數量已達到上限。 |
400 | IllegalParam.VSwitchIds | The parameter VSwitchIds is illegal. | 參數VSwitchIds不合法。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-22 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-10-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |