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

仮想非公開クラウド (VPC) 内の vSwitch をマルチキャストドメインに関連付けて、VPC 内のリソースがマルチキャスト経由で通信できるようにします。

操作説明

1 つの vSwitch は 1 つのマルチキャストドメインにのみ関連付けることができます。関連付ける vSwitch が他のマルチキャストドメインに関連付けられていないことを確認してください。vSwitch とマルチキャストドメインの関連付けを解除するには、「 DisassociateTransitRouterMulticastDomain 」を参照してください。
AssociateTransitRouterMulticastDomain は非同期操作です。リクエストを送信すると、システムは RequestId を返しますが、vSwitch とマルチキャストドメインの関連付けはまだ完了していません。関連付けタスクはバックグラウンドで引き続き実行されます。ListTransitRouterMulticastDomainAssociations を呼び出して、vSwitch とマルチキャストドメインの関連付けステータスをクエリできます。
- 関連付けステータスが Associating の場合、vSwitch とマルチキャストドメインの関連付けが確立中です。この状態では、vSwitch のクエリのみが可能で、他の操作は実行できません。
- 関連付けステータスが Associated の場合、vSwitch とマルチキャストドメインの関連付けが確立されています。
vSwitch が属する VPC は、Enterprise Edition トランジットルーターに接続されている必要があります。VPC 接続を作成するには、「 CreateTransitRouterVpcAttachment 」を参照してください。

今すぐお試しください

この 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:AssociateTransitRouterMulticastDomain

update

*TransitRouterMulticastDomain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。	123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainId	string	必須	マルチキャストドメインの ID。	tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentId	string	必須	VPC 接続の ID。	tr-attach-g3kz2k3u76amsk****
VSwitchIds	array	必須	vSwitch ID のリスト。
	string	必須	vSwitch の ID。一度に最大 5 つの vSwitch を関連付けることができ、1 つのマルチキャストドメインは最大 10 個の vSwitch の関連付けをサポートします。	vsw-p0wxk12u6okfkr8xy****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: vSwitch をマルチキャストドメインに関連付けずにドライランを実行します。システムは必須パラメーター、リクエスト構文、およびビジネス制限をチェックします。ドライランに失敗した場合、エラーメッセージが返されます。ドライランに成功した場合、エラーコード `DryRunOperation` が返されます。 false (デフォルト): ドライランを実行し、リクエストを送信します。ドライランに成功した場合、vSwitch がマルチキャストドメインに関連付けられます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	F88AC12C-943B-50E9-A344-4F8820BB07A7

例

成功レスポンス

JSONJSON

{
  "RequestId": "F88AC12C-943B-50E9-A344-4F8820BB07A7"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidMulticastDomain.NotFound	The specified MulticastDomain is not found.	パラメーターで指定された MulticastDomain が存在しません。
400	IncorrectStatus.MulticastDomain	The status of MulticastDomain is incorrect.	現在の MulticastDomain のステータスではこのポート操作を実行できません。後でもう一度お試しください。
400	InvalidAttachmentId.NotFound	The specified AttachmentId is not found.
400	IllegalParam.AttachmentId	The specified AttachmentId is illegal.	リクエストパラメーターで指定された AttachmentId が無効です。
400	IncorrectStatus.Attachment	The status of Attachment is incorrect.	現在のアタッチのステータスではこのポート操作を実行できません。後でもう一度お試しください。
400	MissingParam.VSwitchIds	The parameter VSwitchIds is mandatory.	VSwitchIds パラメーターが指定されていません。
400	InstanceNotExist	The instance is not exist.	指定されたインスタンスが存在しません。
400	OperationUnsupported.CloudBoxVpc	The specified CloudBoxVpc does not support the operation.	CloudBox VPC はこの操作をサポートしていません。
400	AssociationExist.VSwitchIds	The association already exists.	vSwitch はすでにバインドされています。
400	QuotaFull.VswitchPerMulticastDomain	The number of vswitch associated with multicast domain has exceed the maximum value that can be created.	マルチキャストドメインに関連付けられた vSwitch 数が上限に達しました。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun リクエストの検証が有効です。
400	OperationUnsupported.VpcRegion	The specified Region is not support for this operation.	現在のリージョンではこの操作はサポートされていません。
400	OperationUnsupported.AdvancedFeature	The specified vpc does not support the operation.
400	QuotaFull.MulticastDomainPerVpc	The number of multicast domain that vpc associated has exceed the maximum value that can be associated.	VPC に関連付けられるマルチキャストドメイン数が上限に達しました。
400	IllegalParam.VSwitchIds	The parameter VSwitchIds is illegal.	VSwitchIds パラメーターが無効です。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	この操作を実行するために必須の権限がアカウントにありません。
400	InvalidParameter.TransitRouterAttachmentId	The specified parameter TransitRouterAttachmentId is invalid.
400	InvalidParameter.TransitRouterMulticastDomainId	The specified parameter TransitRouterMulticastDomainId is invalid.	TransitRouterMulticastDomainId パラメーターが無効です。

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

変更履歴

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