調用RegisterTransitRouterMulticastGroupMembers介面建立或添加組播成員。
介面說明
當前企業版轉寄路由器僅支援將彈性網卡 ENI(Elastic Network Interface)指定為組播成員。您可以通過調用RegisterTransitRouterMulticastGroupMembers介面將同地區的 ENI 和跨地區的 ENI 指定為組播成員。
-
如果您指定 NetworkInterfaceIds 參數的值,則表明您需要將當前地區下的 ENI 指定為組播成員。請確保 ENI 所屬的交換器已被關聯至組播域。具體操作,請參見 AssociateTransitRouterMulticastDomain 。
-
如果您指定 PeerTransitRouterMulticastDomains 參數的值,則表明您需要將跨地區相同組播 IP 位址的組播組下的組播成員指定為您當前組播組的組播成員。請確保您已經建立了跨地區串連,具體操作,請參見 CreateTransitRouterPeerAttachment 。
例如:您在華東 1(杭州)地區擁有一個組播域 1,組播域 1 下擁有一個組播組 1,在華東 2(上海)地區擁有一個組播域 2,組播域 2 下擁有組播組 2,組播組 1 和組播組 2 擁有相同的組播 IP 位址,且華東 2(上海)地區的組播組 2 下擁有一個組播成員 2。在您調用
RegisterTransitRouterMulticastGroupMembers介面為華東 1(杭州)地區的組播組 1 建立組播成員時,如果您指定 PeerTransitRouterMulticastDomains 參數的值為華東 2(上海)地區組播域 2 的 ID,則華東 2(上海)地區組播組 2 下的組播成員 2,也將是華東 1(杭州)地區組播組 1 下的組播成員。 -
RegisterTransitRouterMulticastGroupMembers介面屬於非同步介面,即系統會先返回一個 RequestId,但組播成員未完全建立成功,系統背景建立任務仍在進行。您可以調用ListTransitRouterMulticastGroups介面查詢組播成員的狀態。當組播成員處於 Registering 狀態時,表示組播成員正在被建立,在該狀態下,您只能對組播成員執行查詢操作,不能執行其他動作。
當組播成員處於 Registered 狀態時,表示組播成員已被成功建立。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cen:RegisterTransitRouterMulticastGroupMembers |
create |
*TransitRouterMulticastDomain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClientToken |
string |
否 |
用戶端 Token,用於保證請求的等冪性。 從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。 |
123e4567-e89b-12d3-a456-426655440000 |
| TransitRouterMulticastDomainId |
string |
是 |
組播成員所屬的組播域 ID。 |
tr-mcast-domain-91wpg6wbhchjeq**** |
| GroupIpAddress |
string |
是 |
組播成員所屬的組播組的 IP 位址。取值範圍:224.0.1.0~239.255.255.254。 重要
224.0.0.0~224.0.0.127 為系統保留地址,不支援作為組播組 IP 位址。 如果當前組播域下不存在您指定的組播組,系統將自動在當前組播域下為您建立新的組播組。 |
239.XX.XX.2 |
| NetworkInterfaceIds |
array |
否 |
彈性網卡 ID 列表。 |
|
|
string |
否 |
彈性網卡 ID。 一次支援關聯多個彈性網卡。請確保您指定的彈性網卡個數與跨地區組播域的個數之和小於或等於 5。 |
eni-p0weuda3lszwzjly**** |
|
| PeerTransitRouterMulticastDomains |
array |
否 |
跨地區的組播域 ID 列表。 |
|
|
string |
否 |
跨地區的組播域 ID。 一次支援關聯多個跨地區的組播域。請確保您指定的彈性網卡個數與跨地區組播域的個數之和小於或等於 5。 |
tr-mcast-domain-5mjb5gjb6dgu98**** |
|
| DryRun |
boolean |
否 |
是否只預檢此次請求。取值:
|
false |
| VpcId |
string |
否 |
彈性網卡所屬的 VPC 執行個體 ID。
|
vpc-wz9fusm6zq8uy7cfa**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE |
樣本
正常返回樣本
JSON格式
{
"RequestId": "EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IllegalParam.GroupIpAddress | The specified GroupIpAddress is illegal. | 參數中指定的GroupIpAddress不合法。 |
| 400 | InvalidMulticastDomainId.NotFound | The specified AttachmentId is not found. | 參數中指定的MulticastDomain不存在。 |
| 400 | IncorrectStatus.MulticastDomainId | The status of MulticastDomainId is incorrect. | 當前MulticastDomain的狀態不支援該操作,請稍後重試。 |
| 400 | IncorrectStatus.Cen | The status of Cen is incorrect. | 當前Cen的狀態不支援該操作,請稍後重試。 |
| 400 | InstanceNotExist | The instance is not exist. | 指定執行個體不存在。 |
| 400 | InvalidOperation.PeerMulticastDomainRegion | Operation is invalid because to peer multicast domain in the same region with multicast domain. | |
| 400 | InvalidOperation.MulticastDomainStatus | Operation is invalid, due to multicast domain not Active. | 當前組播域狀態不支援該操作,請稍後重試。 |
| 400 | InvalidOperation.BandwidthLimitNotExist | Operation is invalid because a bandwidth limit not exist. | 頻寬包限速不存在。 |
| 400 | AttachmentNotFound | "The attachment does not exist. | |
| 400 | IncorrectStatus.AttachmentId | The status of AttachmentId is incorrect. | 當前Attachment的狀態不支援該操作,請稍後重試。 |
| 400 | InstanceExist | The instance already exists. | 指定執行個體已經存在。 |
| 400 | InvalidOperation.NetworkInterfaceNotExist | Operation is invalid bacause network interface not exist. | NetworkInterface不存在。 |
| 400 | InvalidOperation.NTRNetworkInterfaceNotSupport | Operation is invalid, due to ntr eni not support. | 轉寄路由器的Eni不允許加入組播組中。 |
| 400 | InvalidOperation.MulticastDomainAssociationNotExist | Operation is invalid because multicast association domain association not exist. | 組播域關聯不存在,無法支援當前操作。 |
| 400 | InvalidOperation.MulticastDomainAssociationStatus | Operation is invalid, due to multicast domain association not Active. | 當前組播域關聯狀態不支援該操作,請稍後重試。 |
| 400 | InvalidPeerTrMulticastDomainId.NotFound | The specified PeerTrMulticastDomainId is not found. | 參數中指定的PeerTrMulticastDomainId不存在。 |
| 400 | IncorrectStatus.PeerTrMulticastDomainId | The status of PeerTrMulticastDomainId is incorrect. | 當前PeerTrMulticastDomain的狀態不支援該操作,請稍後重試。 |
| 400 | IllegalParam.PeerTrMulticastDomainId | The specified PeerTrMulticastDomainId is illegal. | 參數中指定的PeerTrMulticastDomainId不合法。 |
| 400 | InvalidOperation | Operation is invalid. | 非法操作。 |
| 400 | QuotaFull.MulticastGroupPerDomain | The number of multicast group has exceed the maximum value that can be created. | 組播域中的組播組數量已達到上限。 |
| 400 | QuotaFull.MulticastMemberPerGroup | The number of multicast group member has exceed the maximum value that can be created. | 組播組中的組播成員數量已達到上限。 |
| 400 | QuotaFull.MulticastPeerMemberPerGroup | The number of multicast group member peer domain has exceed the maximum value that can be created. | 組播組中的跨地區成員數量已達到上限。 |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun請求驗證通過。 |
| 400 | InvalidConnectPeerIds.NotFound | The Connect Peer Ids are invalid. | 輸入的Connect Peer ID不合法。 |
| 400 | InvalidVpcId.NotFound | The specified VpcId is not found. | 參數中指定的VpcId不存在。 |
| 400 | OperationUnsupported.ExistsIgmpv2MemberOnEni | An igmpv2 multicast source or multicast member already exists on the ENI. | 彈性網卡上已經存在 igmpv2 類型的組播源或組播成員了。 |
| 400 | InvalidVpcId.NotValid | The specified Vpc is invalid. | 指定的vpcId無效。 |
| 400 | QuotaExceeded.SourceAndMemberPerTransitRouter | The number of multicast group members and sources has exceed the maximum value that can be created. | 每個轉寄路由器下可以支援的組播源和組播成員數量超出限制。 |
| 400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 帳號無許可權操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。