EnableCenVbrHealthCheck - CEN

操作説明

データセンターと Alibaba Cloud 間の Express Connect 回線の接続状態を監視するために、VBR インスタンスのヘルスチェックを構成できます。これは、問題を迅速に特定するのに役立ちます。

ヘルスチェック機能を使用する前に、次の点に注意してください。

VBR インスタンスが静的ルーティングを使用している場合は、ヘルスチェックを構成した後、VBR インスタンスに接続されているデータセンターに静的ルートを作成します。静的ルートの宛先 CIDR ブロックをヘルスチェックの送信元 IP アドレスに設定し、サブネットマスクを 32 ビットに設定し、ネクストホップを VBR インスタンスの Alibaba Cloud 側 IP アドレスに設定します。
VBR インスタンスが Border Gateway Protocol (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 アドレスは、次のいずれかの方法で構成できます。自動 IP アドレス（推奨）：システムは 100.96.0.0/16 CIDR ブロックから自動的に IP アドレスを割り当てます。カスタム IP アドレス：10.0.0.0/8、192.168.0.0/16、または 172.16.0.0/12 CIDR ブロックから未使用の IP アドレスを指定できます。指定された IP アドレスは、CEN インスタンスでの通信に使用される IP アドレスと競合することはできません。指定された IP アドレスは、VBR インスタンスの Alibaba Cloud 側またはクライアント側 IP アドレスとも競合することはできません。	192.XX.XX.1
HealthCheckTargetIp	string	必須	ヘルスチェックの宛先 IP アドレス。宛先 IP アドレスは、VBR インスタンスのクライアント側 IP アドレスです。	10.XX.XX.1
VbrInstanceOwnerId	integer	任意	VBR インスタンスが属する Alibaba Cloud アカウントの ID です。説明 VBR インスタンスと CEN インスタンスが異なる Alibaba Cloud アカウントに属している場合、このパラメータは必須です。	1250123456123456
HealthCheckInterval	integer	任意	ヘルスチェック中にプローブパケットが送信される時間間隔。単位：秒。デフォルト値：2。有効な値：2 ～ 3。	2
HealthyThreshold	integer	任意	ヘルスチェック中に送信されるプローブパケットの数。単位：パケット。有効な値：3 ～ 8。デフォルト値：8。	8
HealthCheckOnly	boolean	任意	検出機能のみを有効にするかどうかを指定します。有効な値： true：はい。 `検出機能のみを有効にした場合、システムはヘルスチェックを実行しますが、Express Connect 回線がダウンしたときにルートを切り替えません。 > リンクの冗長性を確保する別の方法があることを確認してください。そうでない場合、ネットワークの中断が発生する可能性があります。` 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"
}

エラーレスポンス

JSONJSON

{
  "RequestId": "A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A",
  "CenId": "Cen-atlpf6evc5kqchpma5",
  "VbrId": "vbr-il7ldy0ux6rb15lc2snrw",
  "RegionId": "cn-hangzhou",
  "SourceIp": "10.10.10.10",
  "TargetIp": "10.10.10.11",
  "PacketNum": "3",
  "Status": "Enable"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	RouteConflict	The specified route already exists.
400	Illegal.SourceIpOrTargetIp	The specified source IP address or destination IP address is invalid.
400	OperationFailed.StatusNotSupport	The VBR or VPC instance to CBN attachment is not in a valid state for the operation.
400	OperationFailed.SourceIpUnSupported	The specified source IP address is unsupported.
400	InvalidStatus.HealthCheck	Can not modify, please delete health check config first.
400	OperationFailed.IpAddressExhausted	No IP addresses are available for allocation.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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