DescribeCenVbrHealthCheck を介した VBR 接続性の監視 - CEN

指定されたリージョンにある仮想ボーダールータ (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	任意	クラウドエンタープライズネットワーク (CEN) インスタンスの ID です。	cen-6hpdgj7ni6pz1k****
VbrInstanceRegionId	string	必須	仮想ボーダールータ (VBR) がデプロイされているリージョンの ID です。詳細については、「DescribeChildInstanceRegions」をご参照ください。	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
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 インスタンスに冗長ルートが使用可能な場合、ヘルスチェックが失敗すると、システムは冗長ルートに切り替えます。 `この機能が無効になっていて、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.

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

変更履歴

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