创建组播成员。
接口说明
当前企业版转发路由器仅支持将弹性网卡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代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:RegisterTransitRouterMulticastGroupMembers | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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.0.1~239.255.255.254。 如果当前组播域下不存在您指定的组播组,系统将自动在当前组播域下为您创建新的组播组。 | 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**** |
返回参数
示例
正常返回示例
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 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。