DescribeCenVbrHealthCheck を介した VBR 接続性の監視 - CEN - Alibaba Cloud - Cloud Enterprise Network

指定されたリージョンの仮想罫線ルーター (VBR) のヘルスチェック情報を照会します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CenId	string	任意	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-6hpdgj7ni6pz1k****
VbrInstanceRegionId	string	必須	VBR インスタンスのリージョン ID。 DescribeChildInstanceRegions 操作を呼び出してリージョン ID を取得できます。	cn-hangzhou
VbrInstanceId	string	任意	VBR インスタンスの ID。	vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerId	integer	任意	VBR インスタンスを所有する Alibaba Cloud アカウントの ID。	1250123456123456
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングにおける 1 ページあたりのエントリ数。有効な値: 1 ～ 50。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
PageSize	integer	ページングにおける 1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumber	integer	ページ番号。	1
TotalCount	integer	エントリの総数。	1
VbrHealthChecks	object
VbrHealthCheck	array<object>	VBR インスタンスのヘルスチェック構成。
	object	The health check configuration.
HealthCheckTargetIp	string	ヘルスチェックの送信先 IP アドレス。	192.XX.XX.1
VbrInstanceId	string	VBR インスタンスの ID。	vbr-bp1kznorjeembsuhl****
VbrInstanceRegionId	string	VBR インスタンスのリージョン ID。	cn-hangzhou
CenId	string	CEN インスタンスの ID。	cen-6hpdgj7ni6pz1k****
HealthyThreshold	integer	ヘルスチェック中に送信されるプローブパケットの数。	8
HealthCheckInterval	integer	ヘルスチェック中にプローブパケットが送信される間隔。単位: 秒。	2
HealthCheckSourceIp	string	ヘルスチェックのソース IP アドレス。	172.XX.XX.1
HealthCheckOnly	boolean	ヘルスチェック検出特徴のみが有効かどうかを示します。 true: ヘルスチェック検出特徴のみが有効です。 `ヘルスチェック検出特徴のみが有効な場合、ヘルスチェックでリンク障害が検出されてもルートのスイッチオーバーはトリガーされません。` false: ヘルスチェック検出特徴以外の機能も有効です。 `この特徴が無効な場合、ヘルスチェックでリンク障害が検出され、かつ CEN インスタンスに冗長ルートが存在する場合、ヘルスチェックは直ちにルートのスイッチオーバーをトリガーして利用可能なリンクを使用します。`	false
Description	string	説明。	healthcheck_description

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "B8C9702E-304A-4E18-AC89-BE2D91C2C176",
  "PageNumber": 1,
  "TotalCount": 1,
  "VbrHealthChecks": {
    "VbrHealthCheck": [
      {
        "HealthCheckTargetIp": "192.XX.XX.1",
        "VbrInstanceId": "vbr-bp1kznorjeembsuhl****",
        "VbrInstanceRegionId": "cn-hangzhou",
        "CenId": "cen-6hpdgj7ni6pz1k****",
        "HealthyThreshold": 8,
        "HealthCheckInterval": 2,
        "HealthCheckSourceIp": "172.XX.XX.1",
        "HealthCheckOnly": false,
        "Description": "healthcheck_description"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	アカウントにこの操作を実行する権限がありません。

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

変更履歴

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