マルチキャストドメインのマルチキャストソースとメンバーを照会します。
使用上の注意
ListTransitRouterMulticastGroups
を呼び出して、マルチキャストドメイン内のマルチキャストソースとメンバーを照会できます。 マルチキャストソースおよびメンバーは、マルチキャストリソースとしても知られている。
- GroupIpAddressを設定した場合、システムはマルチキャストグループごとにマルチキャストドメインのマルチキャストリソースを照会します。
- VSwitchIdsを設定した場合、システムはvSwitchによってマルチキャストドメインのマルチキャストリソースを照会します。
- PeerTransitRouterMulticastDomainsを設定した場合、システムは別のリージョンにもデプロイされているマルチキャストリソースを照会します。
- ResourceTypeを設定した場合、システムはマルチキャストドメイン内の指定されたタイプのマルチキャストリソースを照会します。
- ResourceIdを設定した場合、システムはリソースごとにマルチキャストリソースを照会します。
- TransitRouterMulticastDomainIdのみを設定した場合、システムはマルチキャストドメイン内のすべてのマルチキャストリソースを照会します。
デバッグ
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
操作 | String | 必須 | ListTransitRouterMulticastGroups |
実行する操作です。 値をListTransitRouterMulticastGroupsに設定します。 |
ClientToken | String | 任意 | 123e4567-e89b-12d3-a456-426655440000 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。 |
TransitRouterMulticastDomainId | String | 必須 | tr-mcast-domain-5mjb5gjb6dgu98 **** |
マルチキャストドメインのID。 |
GroupIpAddress | String | 任意 | 239.XX.XX.2 |
マルチキャストグループのIPアドレス。 各マルチキャストグループは、そのIPアドレスによって識別される。 |
TransitRouterAttachmentId | String | 任意 | tr-attach-g3kz2k3u76amsk **** |
ネットワークインスタンス接続のID。 |
ResourceType | String | 任意 | VPC |
マルチキャストリソースのタイプ。 設定可能な値は以下のとおりです。
|
ResourceId | String | 任意 | vpc-p0w9alkte4w2htrqe **** |
マルチキャストリソースに関連付けられているリソースのID。 |
MaxResults | Long | 任意 | 20 |
各ページで返されるエントリ数。 デフォルト値: 20 |
NextToken | String | 任意 | FFmyTO70tTpLG6I3FmYAXGKPd **** |
次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。
|
VSwitchIds.N | String | 任意 | vsw-p0w9s2ig1jnwgrbzl **** |
VSwitch の ID です。 最大20個のIDを指定できます。 |
PeerTransitRouterMulticastDomains.N | String | 任意 | tr-mcast-domain-91wpg6wbhchjeq **** |
リージョン間マルチキャストドメインのID。 最大20個のリージョン間マルチキャストドメインIDを指定できます。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
RequestId | String | FB3C4A16-0933-5850-9D43-0C3EA37BCBFB |
リクエストの ID です。 |
TotalCount | Integer | 1 |
返されたエントリの数。 |
MaxResults | Integer | 20 |
1 ページあたりで返されるエントリ数。 |
NextToken | String | FFmyTO70tTpLG6I3FmYAXGKPd **** |
次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。
|
TransitRouterMulticastGroups | TransitRouterMulticastGroupの配列 |
マルチキャストグループに関する情報。 |
|
GroupIpAddress | String | 239.XX.XX.2 |
マルチキャストリソースが属するマルチキャストグループのIPアドレス。 |
TransitRouterAttachmentId | String | tr-attach-g3kz2k3u76amsk **** |
ネットワークインスタンス接続のID。 |
VSwitchId | String | vsw-p0w9s2ig1jnwgrbzl **** |
マルチキャストリソースが属するvSwitchのID。 |
NetworkInterfaceId | String | eni-p0weuda3lszwzjly **** |
マルチキャストリソースであるENIのID。 |
PeerTransitRouterMulticastDomainId | String | tr-mcast-domain-91wpg6wbhchjeq **** |
リージョン間でデプロイされているマルチキャストリソースに関連付けられているマルチキャストドメインのID。 |
Status | String | 登録済み |
マルチキャストリソースのステータス。 設定可能な値は以下のとおりです。
|
GroupSource | ブール | 偽 |
マルチキャストリソースがマルチキャストソースであるかどうかを示します。 設定可能な値は以下のとおりです。
|
グループメンバー | ブール | 真実 |
マルチキャストリソースがマルチキャストメンバーかどうかを示します。 設定可能な値は以下のとおりです。
|
MemberType | String | 静的 |
マルチキャストソースのタイプ。 値がStaticの場合、マルチキャストソースは手動で指定されます。 |
SourceType | String | 静的 |
マルチキャストメンバーのタイプ。 値がStaticの場合、マルチキャストメンバーは手動で指定されます。 |
ResourceType | String | VPC |
マルチキャストリソースのタイプ。 設定可能な値は以下のとおりです。
|
ResourceOwnerId | Long | 253460731706911258 |
マルチキャストリソースが属するAlibaba CloudアカウントのID。 |
ResourceId | String | vpc-p0w9alkte4w2htrqe **** |
マルチキャストリソースに関連付けられているリソースのID。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=ListTransitRouterMulticastGroups
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-5mjb5gjb6dgu98 ****
&GroupIpAddress=239.XX. XX.2
&TransitRouterAttachmentId=tr-attach-g3kz2k3u76amsk ****
&VSwitchIds=["vsw-p0w9s2ig1jnwgrbzl ****"]
&PeerTransitRouterMulticastDomains=["tr-mcast-domain-91wpg6wbhchjeq ****"]
&ResourceType=VPC
&ResourceId=vpc-p0w9alkte4w2htrqe ****
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd ****
&<共通リクエストパラメーター>
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListTransitRouterMulticastGroupsResponse>
<RequestId>FB3C4A16-0933-5850-9D43-0C3EA37BCBFB</RequestId>
<TotalCount> 1 </ TotalCount>
<MaxResults>20</MaxResults>
<NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
<TransitRouterMulticastGroups>
<GroupIpAddress>239.XX. XX.2</GroupIpAddress>
<TransitRouterAttachmentId>tr-attach-g3kz2k3u76amsk ****</TransitRouterAttachmentId>
<VSwitchId>vsw-p0w9s2ig1jnwgrbzl ****</VSwitchId>
<NetworkInterfaceId>eni-p0weuda3lszwzjly ****</NetworkInterfaceId>
<PeerTransitRouterMulticastDomainId>tr-mcast-domain-91wpg6wbhchjeq ****</PeerTransitRouterMulticastDomainId>
<ステータス> 登録済み </ステータス>
<GroupSource>false</GroupSource>
<GroupMember>true</GroupMember>
<MemberType> 静的 </MemberType>
<SourceType> 静的 </SourceType>
<ResourceType>VPC</ResourceType>
<ResourceOwnerId>253460731706911260</ResourceOwnerId>
<ResourceId>vpc-p0w9alkte4w2htrqe ****</ResourceId>
</TransitRouterMulticastGroups>
</ListTransitRouterMulticastGroupsResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "FB3C4A16-0933-5850-9D43-0C3EA37BCBFB" 、
"TotalCount" : 1、
"MaxResults" : 20、
"NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
"TransitRouterMulticastGroups" : [ {
"GroupIpAddress" : "239.XX. XX.2" 、
"TransitRouterAttachmentId" : "tr-attach-g3kz2k3u76amsk ****" 、
"VSwitchId" : "vsw-p0w9s2ig1jnwgrbzl ****" 、
"NetworkInterfaceId" : "eni-p0weuda3lszwzjly ****" 、
"PeerTransitRouterMulticastDomainId" : "tr-mcast-domain-91wpg6wbhchjeq ****" 、
"ステータス" : "登録済み" 、
"GroupSource" : false、
"GroupMember" : true、
"MemberType" : "静的" 、
"SourceType" : "静的" 、
"ResourceType" : "VPC" 、
"ResourceOwnerId" : 253460731706911260、
"ResourceId" : "vpc-p0w9alkte4w2htrqe ****"
} ]
}
エラーコード
エラーコードリストについては、「API エラーセンター」をご参照ください。