DescribeVbrHa - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries virtual border router (VBR) failover groups.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeVbrHa	Read	VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	CBCE910E-D396-4944-8****
DryRun	boolean	No	Specifies whether to precheck the request. Valid values: true: prechecks the request without performing the operation. The system checks the request format, instance status, and whether the required parameters are specified. An error message is returned if the request fails the precheck. If the request passes the precheck, `DRYRUN.SUCCESS` is returned. false: prechecks the request. After the request passes the precheck, the operation is performed.	false
VbrId	string	No	The ID of the VBR.	vbr-bp1jcg5cmxjbl9xgc****
VbrHaId	string	No	The ID of the VBR failover group.	vbrha-sa1sxheuxtd98****
RegionId	string	Yes	The ID of the region where the VBR is deployed.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object
CreationTime	string	The time when the VBR was created.	2021-06-08T12:20:55
Status	string	The state of the VBR failover group. Creating: The VBR failover group is being created. Active: The VBR failover group is running as expected.	Active
RequestId	string	The ID of the request.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
Description	string	The description of the VBR failover group. The description must be 2 to 256 characters in length. It must start with a letter and cannot start with `http://`or `https://`.	desc
VbrHaId	string	The ID of the VBR failover group.	vbrha-sa1sxheuxtd98****
PeerVbrId	string	The ID of the other VBR in the VBR failover group.	vbr-bp12mw1f8k3jgygk9****
Name	string	The name of the VBR failover group.	VBRHa
VbrId	string	The ID of the VBR.	vbr-bp1jcg5cmxjbl9xgc****
RegionId	string	The ID of the region where the VBR is deployed.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "CreationTime": "2021-06-08T12:20:55",
  "Status": "Active",
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "Description": "desc",
  "VbrHaId": "vbrha-sa1sxheuxtd98****",
  "PeerVbrId": "vbr-bp12mw1f8k3jgygk9****",
  "Name": "VBRHa",
  "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
  "RegionId": "cn-hangzhou"
}

Error codes

HTTP status code	Error code	Error message
404	ResourceNotFound.VbrHa	The VBR HA resource is not found.

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

Change history

Change time

Summary of changes

Operation

2023-09-11

API Description Update,The error codes of the API operation change.

see changesets

Change item	Change content
API Description	API Description Update
Error Codes	The error codes of the API operation change.
	delete Error Codes: 404