指定したリージョンの仮想ボーダールーター (VBR) のヘルスチェック設定を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeCenVbrHealthCheck

実行する操作です。 Set the value to DescribeCenVbrHealthCheck.

CenId String 任意 cen-6hpdgj7ni6pz1k****

CEN インスタンスの ID。

VbrInstanceRegionId String 必須 cn-hangzhou

VBRがデプロイされているリージョンのID。

DescribeChildInstanceRegionsを呼び出して、最新のリージョンリストを照会できます。

VbrInstanceId String 任意 vbr-bp1kznorjeembsuhl ****

VBR の ID。

VbrInstanceOwnerId Long 任意 253460731706911258

VBRを所有するAlibaba CloudアカウントのID。

説明 このパラメータは、VBRとCENインスタンスが異なるAlibaba Cloudアカウントに属している場合に必要です。
PageNumber Integer 任意 1

返されるページ数。 既定値：1

PageSize Integer 任意 10

各ページで返されるエントリ数。 Valid values: 1 to 50. デフォルト値: 10

レスポンスパラメーター

パラメーター データ型 例 説明
PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String B8C9702E-304A-4E18-AC89-BE2D91C2C176

リクエストの ID です。

PageNumber Integer 1

返されたページの数です。

TotalCount Integer 1

返されたエントリの総数。

VbrHealthChecks Array of VbrHealthCheck

VBRのヘルスチェック設定。

VbrHealthCheck
HealthCheckTargetIp String 192.XX.XX.1

ヘルスチェックのターゲット IP アドレス。

VbrInstanceId String vbr-bp1kznorjeembsuhl ****

VBR の ID。

VbrInstanceRegionId String cn-hangzhou

VBRがデプロイされているリージョンのID。

CenId String cen-6hpdgj7ni6pz1k ****

CEN インスタンスの ID。

HealthyThreshold Integer 8

ヘルスチェック中に送信されるプローブパケットの数。

HealthCheckInterval Integer 2

ヘルスチェック中にプローブパケットが送信される時間間隔。 (単位：秒)

HealthCheckSourceIp String 172.XX.XX.1

ヘルスチェックのソース IP アドレス。

HealthCheckOnly Boolean false

プロービングが有効かどうかを示します。 設定可能な値は以下のとおりです。

  • true: yes

    プロービングが有効になっている場合、検出されたルートに到達できない場合、システムは別のルートに切り替わりません。

  • false: いいえ

    プロービングが無効になっていて冗長ルートが指定されている場合、検出されたルートに到達できない場合、システムは冗長ルートに切り替わります。

例

リクエストの例

http(s):// [エンドポイント]/?Action=DescribeCenVbrHealthCheck
&CenId=cen-6hpdgj7ni6pz1k ****
&VbrInstanceRegionId=cn-hangzhou
&VbrInstanceId=vbr-bp1kznorjeembsuhl ****
&VbrInstanceOwnerId=253460731706911258
&PageNumber=1
&PageSize=10
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCenVbrHealthCheckResponse>
    <PageSize>10</PageSize>
    <RequestId>B8C9702E-304A-4E18-AC89-BE2D91C2C176</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VbrHealthChecks>
        <HealthCheckTargetIp>192.XX. XX.1</HealthCheckTargetIp>
        <VbrInstanceId>vbr-bp1kznorjeembsuhl****</VbrInstanceId>
        <VbrInstanceRegionId>cn-hangzhou</VbrInstanceRegionId>
        <CenId>cen-6hpdgj7ni6pz1k ****</CenId>
        <HealthyThreshold>8</HealthyThreshold>
        <HealthCheckInterval>2</HealthCheckInterval>
        <HealthCheckSourceIp>172.XX. XX.1</HealthCheckSourceIp>
        <HealthCheckOnly>false</HealthCheckOnly>
    </VbrHealthChecks>
</DescribeCenVbrHealthCheckResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "B8C9702E-304A-4E18-AC89-BE2D91C2C176" 、
  "PageNumber" : 1,
  "TotalCount" : 1、
  "VbrHealthChecks" : [ {
    "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
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。