ListTransitRouterMulticastDomains - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

ListTransitRouterMulticastDomains 操作を呼び出して、マルチキャストドメインに関する情報（ステータス、ID、説明など）をクエリします。

操作説明

RegionId と CenId の両方を指定する必要があります。RegionId のみを指定した場合、マルチキャストドメインに関する情報は返されません。TransitRouterId または TransitRouterMulticastDomainId を個別に指定することもできます。
有効なパラメーター値を指定していることを確認してください。無効なパラメーターを指定すると、システムは RequestId を返しますが、マルチキャストドメインの詳細は返しません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:ListTransitRouterMulticastDomains

list

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/*

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。異なるリクエスト間で一意のトークンを生成します。トークンには ASCII 文字のみを含めることができます。	123e4567-e89b-12d3-a456-426655440000
CenId	string	任意	CEN インスタンスの ID。	cen-a7syd349kne38g****
TransitRouterId	string	任意	トランジットルーターの ID。	tr-p0wr9p28r92d598y6****
TransitRouterMulticastDomainId	string	任意	マルチキャストドメインの ID。	tr-mcast-domain-3r3bvbypxqheej****
RegionId	string	任意	トランジットルーターがデプロイされているリージョンの ID。 DescribeChildInstanceRegions 操作を呼び出して、リージョン ID を取得できます。	cn-hangzhou
MaxResults	integer	任意	1 ページあたりのエントリ数。デフォルト値: 20。	20
NextToken	string	任意	次のクエリに使用されるトークン。有効な値: これが最初のクエリであるか、次のクエリを送信しない場合は、このパラメーターを空のままにします。次のクエリを送信する場合は、このパラメーターを前回の呼び出しで返された NextToken の値に設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	任意	タグ。最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	タグキー。タグキーは空の文字列にできません。タグキーは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	TagKey
Value	string	任意	タグの値。タグの値は、空の文字列または最大 128 文字の文字列にすることができます。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。各タグキーには、対応するタグの値を指定する必要があります。最大 20 個のタグの値を指定できます。	TagValue

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2
TotalCount	integer	エントリの総数。	1
MaxResults	integer	1 ページあたりのエントリ数。	20
NextToken	string	次のクエリのトークン。 NextToken の値が空の場合、次のクエリは送信されません。 NextToken に値が返された場合、その値は次のクエリに使用されるトークンです。	FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastDomains	array<object>	マルチキャストドメインのリスト。
	array<object>	マルチキャストドメインの詳細。
TransitRouterMulticastDomainId	string	マルチキャストドメインの ID。	tr-mcast-domain-3r3bvbypxqheej****
TransitRouterMulticastDomainName	string	マルチキャストドメインの名前。	nametest
TransitRouterMulticastDomainDescription	string	マルチキャストドメインの説明。	desctest
Status	string	マルチキャストドメインのステータス。値は Active で、マルチキャストドメインが利用可能であることを示します。	Active
Tags	array<object>	タグのリスト。
	object
Key	string	タグキー。	TagKey
Value	string	タグの値。	TagValue
TransitRouterId	string	トランジットルーターの ID。	tr-bp1c23ijrl6d6c226h***
RegionId	string	トランジットルーターがデプロイされているリージョンの ID。 DescribeChildInstanceRegions 操作を呼び出して、リージョン ID を取得できます。	cn-hangzhou
CenId	string	CEN インスタンスの ID。	cen-h19xdb0qy2b3ir****
Options	object	マルチキャストドメインのオプション。
Igmpv2Support	string	マルチキャストドメインで IGMPv2 が有効になっているかどうかを示します。	enable

例

成功レスポンス

JSONJSON

{
  "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-h19xdb0qy2b3ir****",
      "Options": {
        "Igmpv2Support": "enable"
      }
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.NextToken	The specified NextToken is illegal.
400	IllegalParam.TrInstance	The specified TrInstance is illegal.
400	IllegalParam.CenId	The specified CenId is illegal.
400	IllegalParam.MaxResults	The specified MaxResults is illegal.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。