All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenVbrHealthCheck

Last Updated:Jan 11, 2023

Queries the health check configuration of a virtual border router (VBR) in a specified region.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
cen:DescribeCenVbrHealthCheck READ
  • CEN
    acs:cen:*:{#accountId}:ceninstance/*
  • CEN
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
  • VPC
    acs:vpc:*:{#accountId}:virtualborderrouter/*
  • VPC
    acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}
    without
without

Request parameters

Parameter Type Required Description Example
CenId string No

The ID of the CEN instance.

cen-6hpdgj7ni6pz1k****
VbrInstanceRegionId string Yes

The ID of the region where the VBR is deployed.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

cn-hangzhou
VbrInstanceId string No

The ID of the VBR.

vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerId long No

The ID of the Alibaba Cloud account that owns the VBR.

Note The parameter is required if the VBR and the CEN instance belong to different Alibaba Cloud accounts.
253460731706911258
PageNumber integer No

The number of the page to return. Default value: 1.

1
PageSize integer No

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

10

Response parameters

Parameter Type Description Example
object
PageSize integer

The number of entries returned per page.

10
RequestId string

The ID of the request.

B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumber integer

The page number of the returned page.

1
TotalCount integer

The total number of entries returned.

1
VbrHealthChecks array

The health check configuration of the VBR.

object
HealthCheckTargetIp string

The destination IP address of the health check.

192.XX.XX.1
VbrInstanceId string

The ID of the VBR.

vbr-bp1kznorjeembsuhl****
VbrInstanceRegionId string

The ID of the region where the VBR is deployed.

cn-hangzhou
CenId string

The ID of the CEN instance.

cen-6hpdgj7ni6pz1k****
HealthyThreshold integer

The number of probe packets that are sent during the health check.

8
HealthCheckInterval integer

The time interval at which probe packets are sent during the health check. Unit: seconds.

2
HealthCheckSourceIp string

The source IP address of the health check.

172.XX.XX.1
HealthCheckOnly boolean

Indicates whether probing is enabled. Valid values:

  • true: yes

    If probing is enabled, the system does not switch to another route when the detected route is not reachable.

  • false: no

    If probing is disabled and a redundant route is specified, the system switches to the redundant route when the detected route is not reachable.

false

Example

Normal return example

JSONFormat

{
  "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": true
      }
    ]
  }
}

Error codes

For a list of error codes, visit the API error center.