Disable the health check for a virtual border router with the DisableCenVbrHealthCheck API - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Operation description

The DisableCenVbrHealthCheck operation is asynchronous. The system returns a RequestId before the health check configuration is completely deleted, and the deletion task continues in the background. You can call the DescribeCenVbrHealthCheck operation to query the health check configuration. If the specified health check configuration cannot be found, the configuration is deleted.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DisableCenVbrHealthCheck

update

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*virtualborderrouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	Yes	The Cloud Enterprise Network (CEN) instance ID.	cen-sjfoejfghhjgghjghkg****
VbrInstanceRegionId	string	Yes	The region ID of the VBR. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
VbrInstanceId	string	Yes	The VBR instance ID.	vbr-wz95o9aylj181n5****
VbrInstanceOwnerId	integer	No	The ID of the Alibaba Cloud account to which the VBR belongs. Note This parameter is required if the VBR and the CEN instance belong to different accounts.	1250123456123456

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A

Examples

Success response

JSON format

{
  "RequestId": "A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
400	InvalidParameter.CenId	The specified parameter CenId is invalid.	The entered parameter CenId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.