Docs

Transit Router

Multicast

CreateTransitRouterMulticastGroupMember - Adding a multicast member

Call the CreateTransitRouterMulticastGroupMember API to add a multicast member to a specified multicast domain.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example: CreateTransitRouterMulticastGroupMember

The interface name. The current API name is CreateTransitRouterMulticastGroupMember.

Version string required Example: 2020-04-01

The interface version. The current API version is 2020-04-01.

TransitRouterMulticastDomainId String required Example: tr-md-hy13n2l4c6c0v****

The ID of the multicast domain. You can call DescribeTransitRouterMulticastDomains to obtain the ID of the multicast domain.

GroupIpAddress String required Example: 224.0.1.0

IP address of the multicast group. Value range: 224.0.1.0-239.255.255.254.

NetworkInterfaceId String required Example: eni-p2wedal3eds2hwese****

Network Interface ID.

ClientToken String optional Example: 123e4567-e89b-12d3-a456-42665544****

The Client Token that is used to ensure the request idempotency.

This parameter value is auto-generated by the client. Ensure uniqueness across requests, preventing duplicate actions caused by multiple client retries during API timeouts or server internal errors.

Must not exceed 64 ASCII characters.

If you do not set this parameter, idempotency check is not performed.

Response parameters

This API does not have specific response parameters. For more information, see Response structure.

Request examples

GET /?Action=CreateTransitRouterMulticastGroupMember&Version=2020-04-01&TransitRouterMulticastDomainId=tr-md-hy13n2l4c6c0v****&GroupIpAddress=224.0.1.0&NetworkInterfaceId=eni-p2wedal3eds2hwese**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250721T122440Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250721/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
  "ResponseMetadata": {​
    "RequestId": "20250509174939204032006239DA****",​
    "Action": "CreateTransitRouterMulticastGroupMember",​
    "Version": "2020-04-01",​
    "Service": "transitrouter",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.

Status code	Error codes	Error message	Explanation
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	The parameters of this idempotent request are inconsistent with those used in the previous request.
400	InvalidIPAddress.Malformed	The specified ip address is malformed.	The specified IP address format is invalid.
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	The format of specified ClientToken is invalid. It must not exceed 64 ASCII characters.
400	InvalidTransitRouter.InvalidBusinessStatus	The request is denied because the specified Transit Router is shut down due to arrears.	The specified Transit Router (TR) is suspended due to overdue payments. Action unsupported.
400	InvalidTransitRouter.InvalidStatus	The specified Transit Router is not in the correct status for the request.	The specified Transit Router (TR) is in a status that cannot respond to the request.
400	InvalidTransitRouterMulticastDomain.InvalidStatus	The specified Transit Router multicast domain is not in the correct status for the request.	The specified multicast domain cannot respond to this request due to its status.
400	InvalidTransitRouterMulticastEni.NotSupport	The specified elastic network interface does not support joining multicast group. Only available elastic network interfaces and those used on ECS or VCI support joining multicast group.	The specified elastic network interface cannot be added to the multicast group. You can only add elastic network interfaces that are not attached or have been attached to the ECS or VCI instances into the multicast group.
400	InvalidTransitRouterMulticastGroup.GroupIPAddressIsIPv6	The specified ip address of multicast group is IPv6, only IPv4 multicast group ip address is supported.	The IP address for the specified multicast group is IPv6. Currently, multicast groups support only IPv4 addresses.
400	InvalidTransitRouterMulticastGroup.InvalidGroupIPAddress	The specified multicast group IP address is not within the multicast cidr block.	The IP address of the specified multicast group is not within the multicast CIDR block.
400	QuotaExceeded.TransitRouterMulticastGroupMember	You've reached the limit on the number of multicast group members that you can create on one multicast group.	You have reached the maximum number of multicast members that you can create for a single group.
400	QuotaExceeded.TransitRouterMulticastSourceAndMember	You've reached the limit on the number of multicast sources and members that you can create on one Transit Router.	You have reached the maximum number of multicast sources and members that you can create for a single TR.
403	Forbidden.NoPermissionToOperate	You are not authorized to operate the specified resource.	No permission to manage the specified resource.
404	InvalidEni.NotFound	The specified elastic network interface does not exist.	The specified elastic network interface does not exist.
404	InvalidSubnet.MulticastDomainNotAssociated	The subnet of the specified elastic network interface is not associated to the multicast domain, and the join operation is invalid.	The specified elastic network interface is located in a subnet that is not associated with the multicast domain, and cannot be added to the multicast group.
404	InvalidTransitRouter.NotFound	The specified Transit Router does not exist.	The specified Transit Router (TR) does not exist.
404	InvalidTransitRouterMulticastDomain.NotFound	The specified Transit Router multicast domain does not exist.	The specified multicast domain does not exist.
404	InvalidTransitRouterMulticastEni.VpcNotAttached	The VPC of the specified elastic network interface is not attached to the Transit Router of the multicast domain.	The specified elastic network interface locates in a Virtual Private Cloud (VPC) that is not mounted to the Transit Router (TR) of the multicast domain.
409	InvalidTransitRouterMulticastGroupMember.Conflict	The specified Transit Router multicast group member has already been existed.	The specified multicast member is already present. Duplicate action is not supported.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The idempotent request is in progress.

Last updated: 2026.03.11 11:24:56