すべてのプロダクト
Search
ドキュメントセンター

:ListTransitRouterMulticastDomains

最終更新日:Apr 03, 2024

マルチキャストドメインに関する情報を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター

データ型

必須/任意

説明

操作

String

必須

ListTransitRouterMulticastDomains

実行する操作です。 値をListTransitRouterMulticastDomainsに設定します。

ClientToken

String

任意

123e4567-e89b-12d3-a456-426655440000

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。

CenId

String

必須

cen-a7syd349kne38g ****

Cloud Enterprise Network (CEN) インスタンスのID。

TransitRouterId

String

任意

tr-p0wr9p28r92d598y6 ****

トランジットルーターのID。

TransitRouterMulticastDomainId

String

任意

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

マルチキャストドメインのID。

RegionId

String

任意

cn-hangzhou

トランジットルーターがデプロイされているリージョンのID。

DescribeChildInstanceRegionsを呼び出して、最新のリージョンリストを照会できます。

DryRun

Boolean

任意

false

リクエストのみを事前チェックするかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: リクエストを事前にチェックしますが、マルチキャストドメイン情報は照会しません。 システムは、必要なパラメーター、リクエスト形式、およびサービス制限をチェックします。 If the request fails the precheck, an error message is returned. リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。

  • false (デフォルト): リクエストを送信します。 リクエストが事前チェックに合格した場合、マルチキャストドメインに関する情報が返されます。

説明

このパラメータは使用されていません。

MaxResults

Long

任意

20

各ページで返されるエントリ数。 デフォルト値: 20

NextToken

String

任意

FFmyTO70tTpLG6I3FmYAXGKPd ****

次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。

  • これが最初のクエリである場合、または次のクエリを送信しない場合は、このパラメーターを無視します。

  • 次のクエリを送信する場合は、パラメーターを前回の呼び出しから返されたNextTokenの値に設定します。

レスポンスパラメーター

パラメーター

データ型

説明

RequestId

String

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

リクエストの ID です。

TotalCount

Integer

1

返されたエントリの数。

MaxResults

Integer

20

1 ページあたりで返されるエントリ数。

NextToken

String

FFmyTO70tTpLG6I3FmYAXGKPd ****

次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。

  • NextTokenが空の場合、次のクエリを送信しないことを示します。

  • NextTokenが空でない場合、値は次のクエリで使用されるトークンを示します。

TransitRouterMulticastDomains

TransitRouterMulticastDomainの配列

マルチキャストドメインに関する情報。

TransitRouterMulticastDomainId

String

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

マルチキャストドメインのID。

TransitRouterMulticastDomainName

String

nametest

マルチキャストドメインの名前。

TransitRouterMulticastDomainDescription

String

desktest

マルチキャストドメインの説明。

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=cn-hangzhou
&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" 、
    "ステータス" : "アクティブ"
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。