All Products
Search

This Product

    Cloud Enterprise Network:ListTransitRouterMulticastDomains

    Document Center

    Cloud Enterprise Network:ListTransitRouterMulticastDomains

    Last Updated:Apr 03, 2024

    Queries the information about multicast domains.

    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:ListTransitRouterMulticastDomainsRead
    • TransitRouterMulticastDomain
      acs:cen:*:{#accountId}:centransitroutermulticast/*
    • 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.

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

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

    		cen-a7syd349kne38g****
    TransitRouterIdstringNo

    The transit router ID.

    		tr-p0wr9p28r92d598y6****
    TransitRouterMulticastDomainIdstringNo

    The multicast domain ID.

    		tr-mcast-domain-3r3bvbypxqheej****
    RegionIdstringNo

    The region ID of the transit router.

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

    		cn-hangzhou
    MaxResultslongNo

    The number of entries to return on each page. Default value: 20.

    		20
    NextTokenstringNo

    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****
    Tagobject []No

    The tags.

    You can specify at most 20 tags in each call.

    KeystringNo

    The tag keys.

    The tag keys cannot be an empty string. The tag keys 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 values.

    The tag values 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 parameters.

    RequestIdstring

    The request ID.

    		8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2
    TotalCountinteger

    The total number of entries returned.

    		1
    MaxResultsinteger

    The number of entries returned per page.

    		20
    NextTokenstring

    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****
    TransitRouterMulticastDomainsobject []

    The information about the multicast domain.

    TransitRouterMulticastDomainIdstring

    The ID of the multicast domain.

    		tr-mcast-domain-3r3bvbypxqheej****
    TransitRouterMulticastDomainNamestring

    The name of the multicast domain.

    		nametest
    TransitRouterMulticastDomainDescriptionstring

    The description of the multicast domain.

    		desctest
    Statusstring

    The status of the multicast domain.

    The valid value is Active, which indicates that the multicast domain is available.

    		Active
    Tagsobject []

    The tags.

    Keystring

    The tag key.

    		TagKey
    Valuestring

    The tag value.

    		TagValue
    TransitRouterIdstring

    The transit router ID.

    		tr-bp1c23ijrl6d6c226h***
    RegionIdstring

    The region ID of the transit router.

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

    		cn-hangzhou
    CenIdstring

    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 codeError codeError messageDescription
    400IllegalParam.NextTokenThe specified NextToken is illegal.The error message returned because the NextToken parameter is set to an invalid value.
    400IllegalParam.TrInstanceThe specified TrInstance is illegal.The error message returned because the specified transit router is invalid.
    400IllegalParam.CenIdThe specified CenId is illegal.The error message returned because the specified CEN instance ID is invalid.
    400IllegalParam.MaxResultsThe specified MaxResults is illegal.MaxResults illegal.
    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-08-04The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-07-13The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.