All Products
Search

This Product

    Cloud Enterprise Network:RegisterTransitRouterMulticastGroupMembers

    Document Center

    Cloud Enterprise Network:RegisterTransitRouterMulticastGroupMembers

    Last Updated:Apr 26, 2024

    Creates or adds a multicast member.

    Operation description

    Enterprise Edition transit routers support only elastic network interfaces (ENIs) as multicast members. You can call the RegisterTransitRouterMulticastGroupMembers operation to specify an ENI in the current region or a different region as a multicast member.

    • If you specify a value for the NetworkInterfaceIds parameter, an ENI in the current region is to be specified as a multicast member. Make sure that the ENI and vSwitch are associated with the multicast group. For more information, see AssociateTransitRouterMulticastDomain .

    • If you specify a value for the PeerTransitRouterMulticastDomains, a multicast member in a multicast group that belongs to another region but has the same IP address as the current multicast group is to be specified as a multicast member for the current multicast group. Make sure that an inter-region connection is established between the regions. For more information, see CreateTransitRouterPeerAttachment .

      For example, Multicast Domain 1 is created in the Australia (Sydney) region. Multicast Group 1 is created in Multicast Domain 1. Multicast Domain 2 is created in the UK (London) region. Multicast Group 2 is created in Multicast Domain 2. Multicast Group 1 and Multicast Group 2 use the same IP address. Multicast Group contains a multicast member named Member 2. When you call the RegisterTransitRouterMulticastGroupMembers operation to add a multicast member to Multicast Group 1 in the Australia (Sydney) region, you can set PeerTransitRouterMulticastDomains to the ID of the Multicast Domain 2 in the UK (London) region. As a result, Member 2 in Multicast Group 2 in the UK (London) region is also added to Multicast Group 1 in the Australia (Sydney) region as a multicast member.

    • RegisterTransitRouterMulticastGroupMembers is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterMulticastGroups operation to query the status of a multicast member.

      • If the multicast member is in the Registering, the multicast member is being created. In this case, you can query the multicast member but cannot perform other operations on the multicast member.
      • If the multicast member is in the Registered state, the multicast member is created.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:RegisterTransitRouterMulticastGroupMembersWrite
    • TransitRouterMulticastDomain
      acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-426655440000
    TransitRouterMulticastDomainIdstringYes

    The ID of the multicast domain to which the multicast members belong.

    		tr-mcast-domain-91wpg6wbhchjeq****
    GroupIpAddressstringYes

    The IP address of the multicast group to which the multicast members belong. Valid values: 224.0.0.1 to 239.255.255.254.

    If the multicast group does not exist in the specified multicast domain, the system automatically creates the multicast group in the multicast domain.

    		239.XX.XX.2
    NetworkInterfaceIdsarrayNo

    The IDs of the ENIs.

    stringNo

    The ID of the ENI

    You can specify multiple ENIs in each call. Make sure that the sum of the number of ENIs and the number of inter-region multicast domains is not larger than five.

    		eni-p0weuda3lszwzjly****
    PeerTransitRouterMulticastDomainsarrayNo

    The IDs of inter-region multicast domains.

    stringNo

    The ID of the inter-region multicast domain.

    You can specify multiple inter-region multicast domains in each call. Make sure that the sum of the number of ENIs and the number of inter-region multicast domains is not larger than five.

    		tr-mcast-domain-5mjb5gjb6dgu98****
    DryRunbooleanNo

    Specifies whether to perform a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the request.
    		false
    VpcIdstringNo

    The ID of the VPC to which the ENI belongs.

    • If the ENI belongs to the current Alibaba Cloud account, ignore this parameter.
    • If the ENI belongs to a different Alibaba Cloud account, you must set this parameter.
    		vpc-wz9fusm6zq8uy7cfa****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.GroupIpAddressThe specified GroupIpAddress is illegal.The error message returned because the GroupIpAddress parameter is set to an invalid value.
    400InvalidMulticastDomainId.NotFoundThe specified AttachmentId is not found.The error message returned because the specified multicast domain does not exist.
    400IncorrectStatus.MulticastDomainIdThe status of MulticastDomainId is incorrect.The error message returned because the status of the specified multicast domain does not support this operation. Try again later.
    400IncorrectStatus.CenThe status of Cen is incorrect.The error message returned because the status of the specified CEN instance does not support this operation. Try again later.
    400InstanceNotExistThe instance is not exist.The error message returned because the specified instance does not exist.
    400InvalidOperation.PeerMulticastDomainRegionOperation is invalid because to peer multicast domain in the same region with multicast domain.-
    400InvalidOperation.MulticastDomainStatusOperation is invalid, due to multicast domain not Active.The error message returned because the status of the specified multicast domain does not support this operation.
    400InvalidOperation.BandwidthLimitNotExistOperation is invalid because a bandwidth limit not exist.The error message returned because the specified bandwidth cap of the bandwidth plan does not exist.
    400AttachmentNotFound"The attachment does not exist.-
    400IncorrectStatus.AttachmentIdThe status of AttachmentId is incorrect.The error message returned because the status of the attachment does not support this operation. Try again later.
    400InstanceExistThe instance already exists.The error message returned because the specified instance already exists.
    400InvalidOperation.NetworkInterfaceNotExistOperation is invalid bacause network interface not exist.The error message returned because the network instance does not exist.
    400InvalidOperation.NTRNetworkInterfaceNotSupportOperation is invalid, due to ntr eni not support.The error message returned because the ENI of the transit router cannot be added to the multicast group.
    400InvalidOperation.MulticastDomainAssociationNotExistOperation is invalid because multicast association domain association not exist.The error message returned because this operation is not supported when the specified multicast domain is not associated with the specified resource.
    400InvalidOperation.MulticastDomainAssociationStatusOperation is invalid, due to multicast domain association not Active.The error message returned because the status of the specified multicast domain does not support this operation. Try again later.
    400InvalidPeerTrMulticastDomainId.NotFoundThe specified PeerTrMulticastDomainId is not found.The error message returned because the specified multicast domain on the peer transit does not exist.
    400IncorrectStatus.PeerTrMulticastDomainIdThe status of PeerTrMulticastDomainId is incorrect.The error message returned because the specified multicast domain on the peer transit router (PeerTrMulticastDomain) does not support this operation. Try again later.
    400IllegalParam.PeerTrMulticastDomainIdThe specified PeerTrMulticastDomainId is illegal.The error message returned because the PeerTrMulticastDomainId parameter is set to an invalid value.
    400InvalidOperationOperation is invalid.The error message returned because the operation is invalid.
    400QuotaFull.MulticastGroupPerDomainThe number of multicast group has exceed the maximum value that can be created.The error message returned because the number of multicast groups in the multicast domain has reached the upper limit.
    400QuotaFull.MulticastMemberPerGroupThe number of multicast group member has exceed the maximum value that can be created.The error message returned because the number of multicast members in the multicast group has reached the upper limit.
    400QuotaFull.MulticastPeerMemberPerGroupThe number of multicast group member peer domain has exceed the maximum value that can be created.The error message returned because the number of multicast members from another region in the multicast group has reached the upper limit.
    400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-01-19The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400