为了实现一对多的组播通信,调用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:RegisterTransitRouterMulticastGroupSources | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-4266**** |
TransitRouterMulticastDomainId | string | 是 | 组播源所属的组播域 ID。 | tr-mcast-domain-5mjb5gjb6dgu98**** |
GroupIpAddress | string | 是 | 组播源所属的组播组的 IP 地址。取值范围:224.0.1.0~239.255.255.254。 注意 224.0.0.0~224.0.0.255 为系统保留地址,不支持作为组播组 IP 地址。 | 239.XX.XX.2 |
NetworkInterfaceIds | array | 否 | 弹性网卡 ID 列表。 | |
string | 否 | 弹性网卡 ID。(即组播源) 当前一个组播组最多一次支持创建五个组播源。 说明
当前本参数为必填参数。
| eni-p0w92o2wupc3c05t**** | |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
VpcId | string | 否 | 弹性网卡所属的 VPC 实例 ID。
| vpc-wz9fusm6zq8uy7cfa**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9C5D5D70-0AFF-5E5C-8D8A-E92C90C8FB08"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidOperation.PeerMulticastDomainSource | Operation is invalid because peer multicast domain can not be group source. | 另一个地域的组播域不能作为组播源。 |
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 | 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 | InstanceNotExist | The instance is not exist. | 指定实例不存在。 |
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 | QuotaFull.MulticastGroupPerDomain | The number of multicast group has exceed the maximum value that can be created. | 组播域中的组播组数量已达到上限。 |
400 | QuotaFull.MulticastSourcePerGroup | The number of multicast group source has exceed the maximum value that can be created. | 组播组中的组播源数量已达到上限。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun请求验证通过。 |
400 | IncorrectStatus.ConnectPeerIds | Connect Peer statuses are incorrect. | Connect Peer状态不正确。 |
400 | InvalidConnectPeerIds.NotFound | The Connect Peer Ids are invalid. | 输入的Connect Peer ID不合法。 |
400 | OperationUnsupported.ExistsIgmpv2MemberOnEni | An igmpv2 multicast source or multicast member already exists on the ENI. | 弹性网卡上已经存在 igmpv2 类型的组播源或组播成员了。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-11-22 | OpenAPI 错误码发生变更 | 查看变更详情 |