调用ListTransitRouterMulticastDomains接口查询组播域的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTransitRouterMulticastDomains

系统规定参数。取值:ListTransitRouterMulticastDomains

ClientToken String 123e4567-e89b-12d3-a456-426655440000

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

CenId String cen-a7syd349kne38g****

云企业网实例ID。

TransitRouterId String tr-p0wr9p28r92d598y6****

转发路由器实例ID。

TransitRouterMulticastDomainId String tr-mcast-domain-3r3bvbypxqheej****

组播域ID。

RegionId String ap-southeast-2

转发路由器实例所属地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会查询组播域的信息。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接查询组播域的信息。
说明 本参数当前暂不生效。
MaxResults Long 20

分批次查询时每次显示的条目数。默认值:20

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。

返回数据

名称 类型 示例值 描述
RequestId String 8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2

请求ID。

TotalCount Integer 1

列表条目数。

MaxResults Integer 20

分批次查询时每次显示的条目数。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
TransitRouterMulticastDomains Array of TransitRouterMulticastDomain

组播域信息列表。

TransitRouterMulticastDomainId String tr-mcast-domain-3r3bvbypxqheej****

组播域ID。

TransitRouterMulticastDomainName String nametest

组播域的名称。

TransitRouterMulticastDomainDescription String desctest

组播域的描述信息。

Status String Active

组播域的状态。

仅取值:Active,表示组播域当前可用。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouterMulticastDomains
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&CenId=cen-a7syd349kne38g****
&TransitRouterId=tr-p0wr9p28r92d598y6****
&TransitRouterMulticastDomainId=tr-mcast-domain-3r3bvbypxqheej****
&RegionId=ap-southeast-2
&DryRun=false
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterMulticastDomainsResponse>
    <RequestId>8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>20</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TransitRouterMulticastDomains>
        <TransitRouterMulticastDomainId>tr-mcast-domain-3r3bvbypxqheej****</TransitRouterMulticastDomainId>
        <TransitRouterMulticastDomainName>nametest</TransitRouterMulticastDomainName>
        <TransitRouterMulticastDomainDescription>desctest</TransitRouterMulticastDomainDescription>
        <Status>Active</Status>
    </TransitRouterMulticastDomains>
</ListTransitRouterMulticastDomainsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2",
  "TotalCount" : 1,
  "MaxResults" : 20,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TransitRouterMulticastDomains" : [ {
    "TransitRouterMulticastDomainId" : "tr-mcast-domain-3r3bvbypxqheej****",
    "TransitRouterMulticastDomainName" : "nametest",
    "TransitRouterMulticastDomainDescription" : "desctest",
    "Status" : "Active"
  } ]
}

错误码

访问错误中心查看更多错误码。