EnableCenVbrHealthCheck - CEN - Alibaba Cloud - Cloud Enterprise Network

仮想罫線ルーター (VBR) のヘルスチェック構成を有効化または変更し、Express Connect 回線の障害をタイムリーに検出できるようにします。

操作説明

VBR インスタンスのヘルスチェックを設定して、オンプレミスデータセンターと Alibaba Cloud 間の Express Connect 回線の接続性をモニターし、問題を迅速に検出できます。

ヘルスチェック特徴を使用する前に、以下の情報にご注意ください。

VBR インスタンスが静的ルーティングを使用している場合、ヘルスチェックの設定後、VBR インスタンスに接続されているオンプレミスデータセンターに静的ルートエントリを追加する必要があります。静的ルートの送信先 CIDR ブロックは、サブネットマスクが 32 ビットのヘルスチェックソース IP アドレスであり、ネクストホップは VBR インスタンスの Alibaba Cloud 側 IP アドレスです。
罫線ルーターインスタンスが BGP 動的ルーティングプロトコルを使用している場合、オンプレミスデータセンターにルートエントリを追加する必要はありません。
EnableCenVbrHealthCheck 操作は非同期です。この操作を呼び出すと、システムは RequestId を返しますが、ヘルスチェックインスタンスはまだ作成または変更済みではありません。作成タスクまたは変更タスクはバックグラウンドで引き続き実行されます。DescribeCenVbrHealthCheck 操作を呼び出して、ヘルスチェック構成をクエリできます。ヘルスチェック構成が返された場合、ヘルスチェックが作成または変更済みであることを示します。

今すぐお試しください

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

update

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*virtualborderrouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CenId	string	必須	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-hahhfskfkseig****
VbrInstanceRegionId	string	必須	VBR インスタンスのリージョン ID。 DescribeChildInstanceRegions 操作を呼び出してリージョン ID をクエリできます。	cn-shenzhen
VbrInstanceId	string	必須	VBR のインスタンス ID。	vbr-wz95o9aylj181n5mzk****
HealthCheckSourceIp	string	任意	ヘルスチェックのソース IP アドレス。以下の構成方法がサポートされています。自動生成されるソース IP (推奨): システムが 100.96.0.0/16 CIDR ブロックから IP アドレスを自動的に割り当てます。カスタムソース IP: ソース IP アドレスには、10.0.0.0/8、192.168.0.0/16、または 172.16.0.0/12 CIDR ブロック内の未使用の IP アドレスを指定できます。この IP アドレスは、CEN インスタンス内で相互に通信する必要があるアドレス、または VBR インスタンスの Alibaba Cloud 側もしくはクライアント側 IP アドレスとの間で IP アドレス競合を引き起こすものであってはなりません。	192.XX.XX.1
HealthCheckTargetIp	string	必須	ヘルスチェックの送信先 IP アドレス。送信先 IP アドレスは、VBR インスタンスのクライアント側 IP アドレスです。	10.XX.XX.1
VbrInstanceOwnerId	integer	任意	VBR インスタンスを所有する Alibaba Cloud アカウントの ID。説明 VBR インスタンスと CEN インスタンスが異なるアカウントに属する場合、このパラメーターは必須です。	1250123456123456
HealthCheckInterval	integer	任意	ヘルスチェックプローブパケットを送信する間隔。単位: 秒。デフォルト値: 2。有効な値: 2 ～ 3。	2
HealthyThreshold	integer	任意	各ヘルスチェック中に送信されるプローブパケットの数。単位: パケット。有効な値: 3 ～ 8。デフォルト値: 8。	8
HealthCheckOnly	boolean	任意	ヘルスチェック検出特徴のみを有効にするかどうかを指定します。有効な値: true: 検出特徴のみが有効になります。 `ヘルスチェック検出特徴のみが有効になっている場合、ヘルスチェックによってリンクがダウンしていると検出されても、ルートのスイッチオーバーはトリガーされません。 > リンクの冗長性を保証する他の方法があることを確認してください。そうしないと、この特徴を有効にすることでリンク中断が発生する可能性があります。` false (デフォルト): 検出専用特徴は無効です。 `デフォルトでは、この特徴は無効になっています。ヘルスチェックによってリンクがダウンしていると検出された場合、CEN インスタンスに冗長ルートが存在すれば、ヘルスチェックは直ちにルートのスイッチオーバーをトリガーして利用可能なリンクを使用します。`	false
Description	string	任意	説明。説明の長さは 1～256 文字で、`http://` または `https://` で始まることはできません。	testdesc

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

例

成功レスポンス

JSONJSON

{
  "RequestId": "1F59F19C-EFD2-40B1-94D5-65B40CA8E34A"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	RouteConflict	The specified route already exists.	ルートの競合が発生しました。
400	Illegal.SourceIpOrTargetIp	The specified source IP address or destination IP address is invalid.	リクエストパラメーターで指定された SourceIp または TargetIp が無効です。
400	OperationFailed.StatusNotSupport	The VBR or VPC instance to CBN attachment is not in a valid state for the operation.	VBR または VPC の現在のステータスでは、この操作はサポートされていません。後でもう一度お試しください。
400	OperationFailed.SourceIpUnSupported	The specified source IP address is unsupported.	パラメーターで指定されたソース IP アドレスはサポートされていません。IP アドレスを変更してから再試行してください。
400	InvalidStatus.HealthCheck	Can not modify, please delete health check config first.	変更は許可されていません。先にヘルスチェック構成を削除してください。
400	OperationFailed.IpAddressExhausted	No IP addresses are available for allocation.	割り当て可能な IP アドレスがないため、操作は失敗しました。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	この操作を実行するために必須の権限がアカウントにありません。
400	InvalidParameter.CenId	The specified parameter CenId is invalid.

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

変更履歴

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