マルチキャストグループからマルチキャストメンバーを削除します。

使用上の注意

RegisterTransitRouterMulticastGroupMembersは非同期操作です。 リクエストを送信すると、リクエストIDが返されますが、操作はシステムバックグラウンドで実行中です。 ListTransitRouterMulticastGroupsを呼び出して、マルチキャストメンバーのステータスを照会できます。

  • マルチキャストメンバーが登録解除状態の場合、マルチキャストメンバーは削除中です。 In this case, you can query the multicast member but cannot perform other operations.
  • マルチキャストメンバーが見つからない場合、そのマルチキャストメンバーはマルチキャストグループから削除されます。

デバッグ

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

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 DeregisterTransitRouterMulticastGroupMembers

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

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

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

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

TransitRouterMulticastDomainId String 必須 tr-mcast-domain-91wpg6wbhchjeq ****

マルチキャストメンバーが属するマルチキャストドメインのID。

GroupIpAddress String 必須 239.XX.XX.2

マルチキャストメンバーが属するマルチキャストグループのIPアドレス。

NetworkInterfaceIds.N String 任意 eni-p0weuda3lszwzjly ****

elastic network interface (ENI) のID。

複数のENIを指定できます。 指定されたENIおよびマルチキャストドメインの総数が5を超えないようにしてください。

PeerTransitRouterMulticastDomains.N String 任意 tr-mcast-domain-5mjb5gjb6dgu98 ****

別のリージョンにあるマルチキャストドメインのID。

複数のマルチキャストドメインを指定できます。 指定されたENIおよびマルチキャストドメインの総数が5を超えないようにしてください。

DryRun Boolean いいえ false

リクエストのみを事前チェックするかどうかを指定します。 有効な値:

  • true: リクエストのみを事前チェックしますが、マルチキャストメンバーは削除されません。 システムは、必要なパラメーター、リクエスト形式、およびサービス制限をチェックします。 リクエストが事前チェックに合格しなかった場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false (デフォルト): APIリクエストを送信します。 リクエストが事前チェックを通過した後、マルチキャストメンバーは削除されます。

レスポンスパラメーター

項目 データ型 例: 説明 
RequestId String 61D0A553-5E4E-53B5-9DA3-01CBA076A286

リクエストの ID です。

リクエストの例

http(s)://[Endpoint]/?Action=DeregisterTransitRouterMulticastGroupMembers
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-91wpg6wbhchjeq ****
&GroupIpAddress=239.XX. XX.2
&NetworkInterfaceIds=["eni-p0weuda3lszwzjly ****"]
&PeerTransitRouterMulticastDomains=["tr-mcast-domain-5mjb5gjb6dgu98 ****"]
&DryRun=false
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式

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

<DeregisterTransitRouterMulticastGroupMembersResponse>
    <RequestId>61D0A553-5E4E-53B5-9DA3-01CBA076A286</RequestId>
</DeregisterTransitRouterMulticastGroupMembersResponse>

JSON 形式

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

{
  "RequestId" : "61D0A553-5E4E-53B5-9DA3-01CBA076A286"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明 
400 DryRunOperation 要求検証は、DryRunフラグを設定して渡されました。 ドライ実行要求が事前チェックに合格した場合に返されるエラーメッセージ。

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