文档

RegisterTransitRouterMulticastGroupSources - 创建组播源

更新时间:

为了实现一对多的组播通信,调用RegisterTransitRouterMulticastGroupSources接口创建组播源。

接口说明

  • 当前仅支持将弹性网卡 ENI(Elastic Network Interface)指定为组播源。

  • RegisterTransitRouterMulticastGroupSources接口属于异步接口,即系统会先返回一个 RequestId,但组播源未完全创建成功,系统后台的创建任务仍在进行。您可以调用ListTransitRouterMulticastGroups接口查询组播源的状态。

    • 当组播源处于 Registering 状态时,表示组播源正在被创建,在该状态下,您只能对组播源执行查询操作,不能执行其他操作。
    • 当组播源处于 Registered 状态时,表示组播源已被成功创建。

前提条件

在调用RegisterTransitRouterMulticastGroupSources接口创建组播源前,请确保弹性网卡所在的交换机已被关联至组播域。具体操作,请参见 AssociateTransitRouterMulticastDomain

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:RegisterTransitRouterMulticastGroupSourcesWrite
  • TransitRouterMulticastDomain
    acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

请求参数

名称类型必填描述示例值
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-4266****
TransitRouterMulticastDomainIdstring

组播源所属的组播域 ID。

tr-mcast-domain-5mjb5gjb6dgu98****
GroupIpAddressstring

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

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

239.XX.XX.2
NetworkInterfaceIdsarray

弹性网卡 ID 列表。

string

弹性网卡 ID。(即组播源)

当前一个组播组最多一次支持创建五个组播源。

说明 当前本参数为必填参数。
eni-p0w92o2wupc3c05t****
DryRunboolean

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

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

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

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

9C5D5D70-0AFF-5E5C-8D8A-E92C90C8FB08

示例

正常返回示例

JSON格式

{
  "RequestId": "9C5D5D70-0AFF-5E5C-8D8A-E92C90C8FB08"
}

错误码

HTTP status code错误码错误信息描述
400InvalidOperation.PeerMulticastDomainSourceOperation is invalid because peer multicast domain can not be group source.另一个地域的组播域不能作为组播源。
400IllegalParam.GroupIpAddressThe specified GroupIpAddress is illegal.参数中指定的GroupIpAddress不合法。
400InvalidMulticastDomainId.NotFoundThe specified AttachmentId is not found.参数中指定的MulticastDomain不存在。
400IncorrectStatus.MulticastDomainIdThe status of MulticastDomainId is incorrect.当前MulticastDomain的状态不支持该操作,请稍后重试。
400IncorrectStatus.CenThe status of Cen is incorrect.当前Cen的状态不支持该操作,请稍后重试。
400InstanceExistThe instance already exists.指定实例已经存在。
400InvalidOperation.NetworkInterfaceNotExistOperation is invalid bacause network interface not exist.NetworkInterface不存在。
400InvalidOperation.NTRNetworkInterfaceNotSupportOperation is invalid, due to ntr eni not support.转发路由器的Eni不允许加入组播组中。
400InstanceNotExistThe instance is not exist.指定实例不存在。
400InvalidOperation.MulticastDomainAssociationNotExistOperation is invalid because multicast association domain association not exist.组播域关联不存在,无法支持当前操作。
400InvalidOperation.MulticastDomainAssociationStatusOperation is invalid, due to multicast domain association not Active.当前组播域关联状态不支持该操作,请稍后重试。
400QuotaFull.MulticastGroupPerDomainThe number of multicast group has exceed the maximum value that can be created.组播域中的组播组数量已达到上限。
400QuotaFull.MulticastSourcePerGroupThe number of multicast group source has exceed the maximum value that can be created.组播组中的组播源数量已达到上限。
400DryRunOperationRequest validation has been passed with DryRun flag set.DryRun请求验证通过。
400IncorrectStatus.ConnectPeerIdsConnect Peer statuses are incorrect.Connect Peer状态不正确。
400InvalidConnectPeerIds.NotFoundThe Connect Peer Ids are invalid.输入的Connect Peer ID不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-11-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈