文档

AssociateTransitRouterMulticastDomain - 将专有网络VPC下的交换机关联至组播域

更新时间:

为了VPC下的资源可以实现组播通信,调用AssociateTransitRouterMulticastDomain接口将专有网络(VPC)下的交换机(VSwitch)关联到组播域中。

接口说明

  • 一个交换机只支持关联至一个组播域。请确保待关联的交换机未与其他组播域建立关联关系。解除交换机与组播域的关联关系,请参见 DisassociateTransitRouterMulticastDomain

  • AssociateTransitRouterMulticastDomain 接口属于异步接口,即系统会先返回一个 RequestId,但交换机和组播域并未完全建立关联关系,系统后台的关联任务仍在进行。您可以调用 ListTransitRouterMulticastDomainAssociations 接口查询交换机和组播域的关联状态。

    • 当关联状态为 Associating 时,表示交换机和组播域正在建立关联关系,在该状态下,您只能对交换机执行查询操作,不能执行其他操作。
    • 当关联状态为 Associated 时,表示交换机和组播域已成功建立关联关系。
  • 交换机所属的 VPC 必须已经连接到企业版转发路由器。创建 VPC 连接,请参见 CreateTransitRouterVpcAttachment

调试

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

调试

授权信息

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

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

请求参数

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

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

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

123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainIdstring

组播域 ID。

tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentIdstring

VPC 连接 ID。

tr-attach-g3kz2k3u76amsk****
VSwitchIdsarray

交换机 ID 列表。

string

交换机 ID。

一次最多支持关联 5 个交换机,一个组播域最多支持关联 10 个交换机。

vsw-p0wxk12u6okfkr8xy****
DryRunboolean

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

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

F88AC12C-943B-50E9-A344-4F8820BB07A7

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidMulticastDomain.NotFoundThe specified MulticastDomain is not found.参数中指定的MulticastDomain不存在。
400IncorrectStatus.MulticastDomainThe status of MulticastDomain is incorrect.当前MulticastDomain的状态不支持该操作,请稍后重试。
400InvalidAttachmentId.NotFoundThe specified AttachmentId is not found.AttachmentId不存在。
400IllegalParam.AttachmentIdThe specified AttachmentId is illegal.参数中指定的AttachmentId不合法。
400IncorrectStatus.AttachmentThe status of Attachment is incorrect.当前Attachment的状态不支持该操作,请稍后重试。
400MissingParam.VSwitchIdsThe parameter VSwitchIds is mandatory.缺少参数VSwitchIds。
400InstanceNotExistThe instance is not exist.指定实例不存在。
400OperationUnsupported.CloudBoxVpcThe specified CloudBoxVpc does not support the operation.云盒VPC不支持该操作。
400AssociationExist.VSwitchIdsThe association already exists.Vswitch已绑定。
400QuotaFull.VswitchPerMulticastDomainThe number of vswitch associated with multicast domain has exceed the maximum value that can be created.组播域关联的vswitch数量已达到上限。
400DryRunOperationRequest validation has been passed with DryRun flag set.DryRun请求验证通过。
400OperationUnsupported.VpcRegionThe specified Region is not support for this operation.当前地域不支持该操作。
400OperationUnsupported.AdvancedFeatureThe specified vpc does not support the operation.-
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

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