使用CreateTransitRouterMulticastDomain创建组播域-云企业网-阿里云

组播域是在地域范围内定义一个组播网络的范围，只有组播域之内的资源可以发送和接收组播流量，组播域之外的资源无法发送和接收组播流量，您可以调用CreateTransitRouterMulticastDomain接口创建组播域。

接口说明

在调用本接口前，请先了解以下信息：

请确保您已经在待建立组播网络的地域创建了企业版转发路由器，并开启了企业版转发路由器的组播功能。具体操作，请参见 CreateTransitRouter 。

如果您在申请组播资源前已创建了企业版转发路由器实例，则该企业版转发路由器实例不支持开启组播功能，您可以删除当前企业版转发路由器实例，重新创建。如何删除企业版转发路由器实例，请参见 DeleteTransitRouter 。
在调用 CreateTransitRouterMulticastDomain 接口的过程中，如果您指定了 CenId、RegionId 参数的值，则无需指定 TransitRouterId 参数的值；如果您指定了 TransitRouterId 参数的值，则无需指定 CenId 和 RegionId 参数的值。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:CreateTransitRouterMulticastDomain

create

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/*

无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。	123e4567-e89b-12d3-a456-4266****
CenId	string	否	云企业网实例 ID。	cen-a7syd349kne38g****
TransitRouterId	string	否	转发路由器实例 ID。	tr-p0wr9p28r92d598y6****
RegionId	string	否	转发路由器实例所属的地域 ID。您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。	cn-hangzhou
TransitRouterMulticastDomainName	string	否	组播域的名称。名称可以为空或长度为 1～128 个字符，不能以 http://或 https://开头。	nametest
TransitRouterMulticastDomainDescription	string	否	组播域的描述信息。描述可以为空或长度为 1～256 个字符，不能以 http://或 https://开头。	desctest
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建组播域。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后直接创建组播域。	false
Tag	array<object>	否	标签信息。一次最多支持输入 20 个标签信息。
	object	否
Key	string	否	资源的标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。一次最多支持输入 20 个标签的标签键。	TagKey
Value	string	否	资源的标签值。标签值可以为空或输入不超过 128 个字符的字符串，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。每一个标签键对应一个标签值，一次最多支持输入 20 个标签键对应的标签值。	TagValue
Options	object	否	组播域功能选项。
Igmpv2Support	string	否	是否为组播域开启 IGMP 功能，开启该功能后主机可以通过互联网组管理协议 IGMP（Internet Group Management Protocol）协议动态加入或离开组播组。取值： enable：开启 IGMP 功能。 disable（默认值）：未开启 IGMP 功能。说明 IGMP 功能正在公测中，如需使用，请向客户经理申请使用权限。 IGMP 功能开启后不支持关闭。	enable

返回参数

名称	类型	描述	示例值
	object	返回结果。
TransitRouterMulticastDomainId	string	组播域 ID。	tr-mcast-domain-40cwj0rgzgdtam****
RequestId	string	请求 ID。	94E19C6F-206F-5223-9A63-64B85851BC04

示例

正常返回示例

JSON格式

{
  "TransitRouterMulticastDomainId": "tr-mcast-domain-40cwj0rgzgdtam****",
  "RequestId": "94E19C6F-206F-5223-9A63-64B85851BC04"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidTransitRouterId.NotFound	The specified TransitRouterId is not found.	参数中指定的TransitRouterId不存在。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is illegal.	参数中指定的TransitRouterId不合法。
400	IllegalParam.CenId	The specified CenId is illegal.	指定的cenId不合法。
400	IllegalParam.RegionId	The specified RegionId is illegal.	参数中指定的Region不合法。
400	InvalidCenId.NotFound	The specified CenId is not found.	参数中指定的CenId不存在。
400	InvalidOperation.TransitRouterNotExist	Operation is invalid because the transit router not exist.	转发路由器不存在。
400	InvalidOperation.CENInstanceStatus	The CEN instance is not in a valid state for the operation.
400	IncorrectStatus.TransitRouterInstance	The status of TransitRouter is incorrect.	转发路由器状态不正确。
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.	当前TransitRouter类型不支持该操作。
400	OperationUnsupported.ServiceMode	The specified ServiceMode does not support the operation.	当前转发路由器模式不支持该操作。
400	OperationUnsupported.TransitRouterSupportMulticast	The specified TransitRouterSupportMulticast does not support the operation.
400	OperationUnsupported.RegionId	The specified RegionId does not support the operation.	当前地域不支持该操作。
400	IncorrectStatus.Cen	The status of Cen is incorrect.	当前Cen的状态不支持该操作，请稍后重试。
400	IncorrectStatus.TransitRouter	The status of TransitRouter is incorrect.	当前TransitRouter的状态不支持该操作，请稍后重试。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun请求验证通过。
400	QuotaExceeded.MulticastDomain	The MulticastDomain quota is exceeded.	组播域的数量超过限制，无法再增加。
400	IllegalParam.Igmpv2Support	The specified Igmpv2Support is illegal. Valid values are [enable, disable].	参数Igmpv2Support不合法，取值范围：enable、disable。
400	OperationUnsupported.Igmpv2Support	The current UID does not allow the creation of a igmpv2 multicast domain. Please submit a ticket.	当前UID不允许创建igmpv2类型的组播域，请提工单处理。
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

更多信息，参考变更详情。