All Products
Search

This Product

    Cloud Enterprise Network:CreateTransitRouterMulticastDomain

    Document Center

    Cloud Enterprise Network:CreateTransitRouterMulticastDomain

    Last Updated:Apr 03, 2024

    Creates a multicast domain.

    Operation description

    Before you call this operation, read the following rules:

    • Make sure that an Enterprise Edition transit router is deployed in the region where you want to create the multicast domain, and the multicast feature is enabled for the Enterprise Edition transit router. For more information, see CreateTransitRouter .

      If an Enterprise Edition transit router was created before you apply for multicast resources, the transit router does not support multicast. You can delete the transit router and create a new one. For more information about how to delete an Enterprise Edition transit router, see DeleteTransitRouter .

    • When you call CreateTransitRouterMulticastDomain, if you set CenId and RegionId, you do not need to set TransitRouterId. If you set TransitRouterId, you do not need to set CenId or RegionId.

    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:CreateTransitRouterMulticastDomainWrite
    • TransitRouter
      acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}
    • TransitRouterMulticastDomain
      acs:cen:*:{#accountId}:centransitroutermulticast/*
      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 value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters.

    		123e4567-e89b-12d3-a456-4266****
    CenIdstringNo

    The ID of the Cloud Enterprise Network (CEN) instance.

    		cen-a7syd349kne38g****
    TransitRouterIdstringNo

    The ID of the transit router.

    		tr-p0wr9p28r92d598y6****
    RegionIdstringNo

    The ID of the region where the transit router is deployed.

    You can call the DescribeChildInstanceRegions operation to query the most recent region list.

    		cn-hangzhou
    TransitRouterMulticastDomainNamestringNo

    The name of the multicast domain.

    The name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.

    		nametest
    TransitRouterMulticastDomainDescriptionstringNo

    The description of the multicast domain.

    The description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.

    		desctest
    DryRunbooleanNo

    Specifies whether to perform a dry run. Valid values:

    • true: performs a dry run. The system checks the required parameters, request format, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and sends the request.
    		false
    Tagobject []No

    The information about the tags.

    You can specify at most 20 tags in each call.

    KeystringNo

    The tag key.

    The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

    You can specify at most 20 tag keys.

    		TagKey
    ValuestringNo

    The tag value.

    The tag value can be 0 to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

    Each tag key must have a unique tag value. You can specify at most 20 tag values in each call.

    		TagValue

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    TransitRouterMulticastDomainIdstring

    The ID of the multicast domain.

    		tr-mcast-domain-40cwj0rgzgdtam****
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidTransitRouterId.NotFoundThe specified TransitRouterId is not found.The error message returned because the specified transit router ID (TransitRouterId) does not exist.
    400IllegalParam.TransitRouterIdThe specified TransitRouterId is illegal.The error message returned because the specified transit router ID is invalid.
    400IllegalParam.CenIdThe specified CenId is illegal.The error message returned because the specified CEN instance ID is invalid.
    400IllegalParam.RegionIdThe specified RegionId is illegal.The error message returned because the specified region is invalid.
    400InvalidCenId.NotFoundThe specified CenId is not found.The error message returned because the specified CEN instance ID does not exist.
    400InvalidOperation.TransitRouterNotExistOperation is invalid because the transit router not exist.The error message returned because the specified transit router does not exist.
    400InvalidOperation.CENInstanceStatusThe CEN instance is not in a valid state for the operation.The error message returned because the status of the CEN instance does not support this operation.
    400IncorrectStatus.TransitRouterInstanceThe status of TransitRouter is incorrect.The error message returned because the transit router is in an invalid state.
    400OperationUnsupported.TransitRouterTypeThe specified TransitRouterType does not support the operation.The error message returned because this operation is not supported by the specified type of transit router.
    400OperationUnsupported.ServiceModeThe specified ServiceMode does not support the operation.The error message returned because the transit router mode does not support this operation.
    400OperationUnsupported.TransitRouterSupportMulticastThe specified TransitRouterSupportMulticast does not support the operation.-
    400OperationUnsupported.RegionIdThe specified RegionId does not support the operation.The error message returned because this operation is not supported in the specified region.
    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.
    400IncorrectStatus.TransitRouterThe status of TransitRouter is incorrect.The error message returned because the status of the transit router does not support this operation. Try again later.
    400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
    400QuotaExceeded.MulticastDomainThe MulticastDomain quota is exceeded.The error message returned because the number of multicast domains has reached the upper limit. You cannot add more multicast domains.
    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
    2023-01-03The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400