调用RegisterTransitRouterMulticastGroupMembers接口创建组播成员。

使用说明

当前企业版转发路由器仅支持将弹性网卡ENI(Elastic Network Interface)指定为组播成员。您可以通过调用RegisterTransitRouterMulticastGroupMembers接口将同地域的ENI和跨地域的ENI指定为组播成员。

  • 如果您指定NetworkInterfaceIds参数的值,则表明您需要将当前地域下的ENI指定为组播成员。请确保ENI所属的交换机已被关联至组播域。具体操作,请参见AssociateTransitRouterMulticastDomain
  • 如果您指定PeerTransitRouterMulticastDomains参数的值,则表明您需要将跨地域相同组播IP地址的组播组下的组播成员指定为您当前组播组的组播成员。请确保您已经创建了跨地域连接,具体操作,请参见CreateTransitRouterPeerAttachment

    例如您在澳大利亚(悉尼)地域拥有一个组播域1,组播域1下拥有一个组播组1,在英国(伦敦)地域拥有一个组播域2,组播域2下拥有组播组2,组播组1和组播组2拥有相同的组播IP地址,且英国(伦敦)地域的组播组2下拥有一个组播成员2。在您调用RegisterTransitRouterMulticastGroupMembers接口为澳大利亚(悉尼)地域的组播组1创建组播成员时,如果您指定PeerTransitRouterMulticastDomains参数的值为英国(伦敦)地域组播域2的ID,则英国(伦敦)地域组播组2下的组播成员2,也将是澳大利亚(悉尼)地域组播组1下的组播成员。

  • RegisterTransitRouterMulticastGroupMembers接口属于异步接口,即系统会先返回一个RequestId,但组播成员未完全创建成功,系统后台的创建任务仍在进行。您可以调用ListTransitRouterMulticastGroups接口查询组播成员的状态。
    • 当组播成员处于Registering状态时,表示组播成员正在被创建,在该状态下,您只能对组播成员执行查询操作,不能执行其他操作。
    • 当组播成员处于Registered状态时,表示组播成员已被成功创建。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String RegisterTransitRouterMulticastGroupMembers

系统规定参数。取值:RegisterTransitRouterMulticastGroupMembers

ClientToken String 123e4567-e89b-12d3-a456-426655440000

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
TransitRouterMulticastDomainId String tr-mcast-domain-91wpg6wbhchjeq****

组播成员所属的组播域ID。

GroupIpAddress String 239.XX.XX.2

组播成员所属的组播组的IP地址。取值范围:224.0.0.1~239.255.255.254

如果当前组播域下不存在您指定的组播组,系统将自动在当前组播域下为您创建新的组播组。

NetworkInterfaceIds.N String eni-p0weuda3lszwzjly****

弹性网卡ID。

一次最多支持关联5个弹性网卡。

PeerTransitRouterMulticastDomains.N String tr-mcast-domain-5mjb5gjb6dgu98****

跨地域的组播域ID。

一次最多支持关联5个跨地域的组播域。

DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建组播成员。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建组播成员。
VpcId String vpc-wz9fusm6zq8uy7cfa****

弹性网卡所属的VPC实例ID。

  • 如果弹性网卡所属阿里云账号和您当前登录的阿里云账号为相同账号,本参数可不填。
  • 如果弹性网卡所属阿里云账号和您当前登录的阿里云账号为不同账号,本参数必填。

返回数据

名称 类型 示例值 描述
RequestId String EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=RegisterTransitRouterMulticastGroupMembers
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-91wpg6wbhchjeq****
&GroupIpAddress=239.XX.XX.2
&NetworkInterfaceIds=["eni-p0weuda3lszwzjly****"]
&PeerTransitRouterMulticastDomains=["tr-mcast-domain-5mjb5gjb6dgu98****"]
&DryRun=false
&VpcId=vpc-wz9fusm6zq8uy7cfa****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RegisterTransitRouterMulticastGroupMembersResponse>
    <RequestId>EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE</RequestId>
</RegisterTransitRouterMulticastGroupMembersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE"
}

错误码

HttpCode 错误码 错误信息 描述
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。

访问错误中心查看更多错误码。