调用AssociateTransitRouterMulticastDomain接口将专有网络VPC(Virtual Private Cloud)下的交换机关联至组播域。

使用说明

  • 一个交换机只支持关联至一个组播域。请确保待关联的交换机未与其他组播域建立关联关系。解除交换机与组播域的关联关系,请参见DisassociateTransitRouterMulticastDomain
  • AssociateTransitRouterMulticastDomain接口属于异步接口,即系统会先返回一个RequestId,但交换机和组播域并未完全建立关联关系,系统后台的关联任务仍在进行。您可以调用ListTransitRouterMulticastDomainAssociations接口查询交换机和组播域的关联状态。
    • 当关联状态为Associating时,表示交换机和组播域正在建立关联关系,在该状态下,您只能对交换机执行查询操作,不能执行其他操作。
    • 当关联状态为Associated时,表示交换机和组播域已成功建立关联关系。

调试

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

请求参数

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

系统规定参数。取值:AssociateTransitRouterMulticastDomain

ClientToken String 123e4567-e89b-12d3-a456-426655440000

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

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

TransitRouterMulticastDomainId String tr-mcast-domain-91wpg6wbhchjeq****

组播域ID。

TransitRouterAttachmentId String tr-attach-g3kz2k3u76amsk****

VPC连接ID。

VSwitchIds.N String vsw-p0wxk12u6okfkr8xy****

交换机ID。

一次最多支持关联5个交换机。

DryRun Boolean false

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

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

返回数据

名称 类型 示例值 描述
RequestId String F88AC12C-943B-50E9-A344-4F8820BB07A7

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AssociateTransitRouterMulticastDomain
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-91wpg6wbhchjeq****
&TransitRouterAttachmentId=tr-attach-g3kz2k3u76amsk****
&VSwitchIds=["vsw-p0wxk12u6okfkr8xy****"]
&DryRun=false
&公共请求参数

正常返回示例

XML格式

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

<AssociateTransitRouterMulticastDomainResponse>
    <RequestId>F88AC12C-943B-50E9-A344-4F8820BB07A7</RequestId>
</AssociateTransitRouterMulticastDomainResponse>

JSON格式

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

{
  "RequestId" : "F88AC12C-943B-50E9-A344-4F8820BB07A7"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidAttachmentId.NotFound The specified AttachmentId is not found. AttachmentId不存在。
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun请求验证通过。

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