ListTransitRouterMulticastDomains - Cloud Enterprise Network

Queries the information about a multicast domain, such as the status, ID, and description.

Operation description

If you configure one of the RegionId and CenId parameters, you must configure the other parameter. Otherwise, no information about the multicast domain is returned. You can configure only one of the TransitRouterId and TransitRouterMulticastDomainId parameters.
Make sure that all the request parameters are valid. If a request parameter is invalid, a request ID is returned but the information about the multicast domain is not returned.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cen:ListTransitRouterMulticastDomains	list	TransitRouterMulticastDomain acs:cen::{#accountId}:centransitroutermulticast/ TransitRouterMulticastDomain acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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.	123e4567-e89b-12d3-a456-426655440000
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance.	cen-a7syd349kne38g****
TransitRouterId	string	No	The transit router ID.	tr-p0wr9p28r92d598y6****
TransitRouterMulticastDomainId	string	No	The multicast domain ID.	tr-mcast-domain-3r3bvbypxqheej****
RegionId	string	No	The region ID of the transit router. You can call the DescribeChildInstanceRegions operation to query the most recent region list.	cn-hangzhou
MaxResults	long	No	The number of entries to return on each page. Default value: 20.	20
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. If a value is returned for NextToken, specify the value in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	No	The tags. You can specify up to 20 tags in each call.
	object	No
Key	string	No	The tag key. The tag key cannot be an empty string. The key can be up to 64 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. You can specify at most 20 tag keys in each call.	TagKey
Value	string	No	The tag value. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Each key-value pair must be unique. You can specify up to 20 tag values in each call.	TagValue

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries returned per page.	20
NextToken	string	The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastDomains	array<object>	The information about the multicast domain.
TransitRouterMulticastDomain	object
TransitRouterMulticastDomainId	string	The ID of the multicast domain.	tr-mcast-domain-3r3bvbypxqheej****
TransitRouterMulticastDomainName	string	The name of the multicast domain.	nametest
TransitRouterMulticastDomainDescription	string	The description of the multicast domain.	desctest
Status	string	The status of the multicast domain. The valid value is Active, which indicates that the multicast domain is available.	Active
Tags	array<object>	The tags.
Tag	object
Key	string	The tag key.	TagKey
Value	string	The tag value.	TagValue
TransitRouterId	string	The transit router ID.	tr-bp1c23ijrl6d6c226h***
RegionId	string	The region ID of the transit router. You can call the DescribeChildInstanceRegions operation to query the most recent region list.	cn-hangzhou
CenId	string	The CEN instance ID.	cen-a7syd349kne38g****

Examples

Sample success responses

JSONformat

{
  "RequestId": "8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TransitRouterMulticastDomains": [
    {
      "TransitRouterMulticastDomainId": "tr-mcast-domain-3r3bvbypxqheej****",
      "TransitRouterMulticastDomainName": "nametest",
      "TransitRouterMulticastDomainDescription": "desctest",
      "Status": "Active",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TransitRouterId": "tr-bp1c23ijrl6d6c226h***",
      "RegionId": "cn-hangzhou",
      "CenId": "cen-a7syd349kne38g****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is illegal.	The error message returned because the NextToken parameter is set to an invalid value.
400	IllegalParam.TrInstance	The specified TrInstance is illegal.	The error message returned because the specified transit router is invalid.
400	IllegalParam.CenId	The specified CenId is illegal.	The error message returned because the specified CEN instance ID is invalid.
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	MaxResults illegal.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The 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 time	Summary of changes	Operation
2023-08-04	The Error code has changed	View Change Details
2023-07-13	The Error code has changed. The response structure of the API has changed	View Change Details