All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenVbrHealthCheck

Last Updated:Jan 25, 2024

Queries the health check configurations of virtual border routers (VBRs) in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
cen:DescribeCenVbrHealthCheckRead
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
  • virtualborderrouter
    acs:vpc:*:{#accountId}:virtualborderrouter/*
  • virtualborderrouter
    acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringNo

The ID of the Cloud Enterprise Network (CEN) instance.

cen-6hpdgj7ni6pz1k****
VbrInstanceRegionIdstringYes

The ID of the region where the VBRs are deployed.

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

cn-hangzhou
VbrInstanceIdstringNo

The ID of the VBR.

vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerIdlongNo

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

1250123456123456
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

1
VbrHealthChecksobject []

The health check configuration of the VBR.

HealthCheckTargetIpstring

The destination IP address of the health check.

192.XX.XX.1
VbrInstanceIdstring

The VBR ID.

vbr-bp1kznorjeembsuhl****
VbrInstanceRegionIdstring

The ID of the region where the VBR is deployed.

cn-hangzhou
CenIdstring

The ID of the CEN instance.

cen-6hpdgj7ni6pz1k****
HealthyThresholdinteger

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

8
HealthCheckIntervalinteger

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

2
HealthCheckSourceIpstring

The source IP address of the health check.

172.XX.XX.1
HealthCheckOnlyboolean

Indicates whether probing is enabled. Valid values:

  • true: Probing is enabled.

    If you enable probing, the system does not switch to another route if the detected route is not reachable.
    
  • false: Probing is disabled.

      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
Descriptionstring

The description.

healthcheck_description

Examples

Sample success responses

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": false,
        "Description": "healthcheck_description"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-13The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.