调用CreateTransitRouterMulticastDomain接口创建组播域。

使用说明

在调用本接口前,请先了解以下信息:

  • 目前仅澳大利亚(悉尼)、英国(伦敦)地域的企业版转发路由器支持组播功能。组播功能默认不开放,如需使用,请先联系客户经理或提交工单申请组播资源。
  • 请确保您已经在待建立组播网络的地域创建了企业版转发路由器,并开启了企业版转发路由器的组播功能。具体操作,请参见CreateTransitRouter

    如果您在申请组播资源前已创建了企业版转发路由器实例,则该企业版转发路由器实例不支持开启组播功能,您可以删除当前企业版转发路由器实例,重新创建。如何删除企业版转发路由器实例,请参见DeleteTransitRouter

  • 在调用CreateTransitRouterMulticastDomain接口的过程中,如果您指定了CenIdRegionId参数的值,则无需指定TransitRouterId参数的值;如果您指定了TransitRouterId参数的值,则无需指定CenIdRegionId参数的值。

调试

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

请求参数

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

系统规定参数。取值:CreateTransitRouterMulticastDomain

ClientToken String 123e4567-e89b-12d3-a456-4266****

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

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

CenId String cen-a7syd349kne38g****

云企业网实例ID。

TransitRouterId String tr-p0wr9p28r92d598y6****

转发路由器实例ID。

RegionId String ap-southeast-2

转发路由器实例所属的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

TransitRouterMulticastDomainName String nametest

组播域的名称。

名称长度为0~128个字符,可包含大小写字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

TransitRouterMulticastDomainDescription String desctest

组播域的描述信息。

描述长度为0~256个字符,可包含大小写字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

DryRun Boolean false

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

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

返回数据

名称 类型 示例值 描述
TransitRouterMulticastDomainId String tr-mcast-domain-40cwj0rgzgdtam****

组播域ID。

RequestId String 94E19C6F-206F-5223-9A63-64B85851BC04

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouterMulticastDomain
&ClientToken=123e4567-e89b-12d3-a456-4266****
&CenId=cen-a7syd349kne38g****
&TransitRouterId=tr-p0wr9p28r92d598y6****
&RegionId=ap-southeast-2
&TransitRouterMulticastDomainName=nametest
&TransitRouterMulticastDomainDescription=desctest
&DryRun=false
&公共请求参数

正常返回示例

XML格式

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

<CreateTransitRouterMulticastDomainResponse>
    <RequestId>94E19C6F-206F-5223-9A63-64B85851BC04</RequestId>
    <TransitRouterMulticastDomainId>tr-mcast-domain-40cwj0rgzgdtam****</TransitRouterMulticastDomainId>
</CreateTransitRouterMulticastDomainResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectStatus.TransitRouterInstance The status of TransitRouter is incorrect. 转发路由器状态不正确。
400 OperationUnsupported.TransitRouterType The specified TransitRouterType does not support the operation. 该类型转发路由器不支持此操作
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。

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