Help Center> ROMA Connect> API Reference> Service Integration APIs> VPC Channel Management> Modifying VPC Channel Health Checks

Updated on 2023-06-29 GMT+08:00

View PDF

Modifying VPC Channel Health Checks

Function

Modify VPC channel health checks.

URI

PUT /v2/{project_id}/apic/instances/{instance_id}/vpc-channels/{vpc_channel_id}/health-config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID.
vpc_channel_id	Yes	String	VPC channel ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
protocol	Yes	String	Protocol for performing health checks on backend servers in the VPC channel. TCP HTTP HTTPS
path	No	String	Destination path for health checks. This parameter is required if protocol is set to http.
method	No	String	Request method for health checks. Default: GET
port	No	Integer	Destination port for health checks. If this parameter is not specified or set to 0, the host port of the VPC channel is used. If the port has a non-zero value, the port is used for health checks. Minimum: 0 Maximum: 65535
threshold_normal	Yes	Integer	Healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. Minimum: 1 Maximum: 10
threshold_abnormal	Yes	Integer	Unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. Minimum: 1 Maximum: 10
time_interval	Yes	Integer	Interval between consecutive checks. Unit: s. The value must be greater than that of timeout. Minimum: 5 Maximum: 300
http_code	No	String	Response codes for determining a successful HTTP response. The value can be any integer within 100–599 in one of the following formats: Multiple values, for example, 200,201,202 Range, for example, 200-299 Multiple values and ranges, for example, 201,202,210-299. This parameter is required if protocol is set to http.
enable_client_ssl	No	Boolean	Whether to enable two-way authentication. If this function is enabled, the certificate specified by backend_client_certificate in the instance configuration is used. Default: false
status	No	Integer	Health check status 1: available 2: unavailable
timeout	Yes	Integer	Timeout for determining whether a health check fails, in seconds. The value must be less than the value of time_interval. Minimum: 2 Maximum: 30

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
protocol	String	Protocol for performing health checks on backend servers in the VPC channel. TCP HTTP HTTPS
path	String	Destination path for health checks. This parameter is required if protocol is set to http.
method	String	Request method for health checks. Default: GET
port	Integer	Destination port for health checks. If this parameter is not specified or set to 0, the host port of the VPC channel is used. If the port has a non-zero value, the port is used for health checks. Minimum: 0 Maximum: 65535
threshold_normal	Integer	Healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. Minimum: 1 Maximum: 10
threshold_abnormal	Integer	Unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. Minimum: 1 Maximum: 10
time_interval	Integer	Interval between consecutive checks. Unit: s. The value must be greater than that of timeout. Minimum: 5 Maximum: 300
http_code	String	Response codes for determining a successful HTTP response. The value can be any integer within 100–599 in one of the following formats: Multiple values, for example, 200,201,202 Range, for example, 200-299 Multiple values and ranges, for example, 201,202,210-299. This parameter is required if protocol is set to http.
enable_client_ssl	Boolean	Whether to enable two-way authentication. If this function is enabled, the certificate specified by backend_client_certificate in the instance configuration is used. Default: false
status	Integer	Health check status 1: available 2: unavailable
timeout	Integer	Timeout for determining whether a health check fails, in seconds. The value must be less than the value of time_interval. Minimum: 2 Maximum: 30
vpc_channel_id	String	VPC channel ID.
id	String	Health check ID.
create_time	String	Creation time.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

{
  "http_code" : "200",
  "path" : "/vpc/demo",
  "port" : 22,
  "protocol" : "http",
  "threshold_abnormal" : 5,
  "threshold_normal" : 2,
  "time_interval" : 10,
  "timeout" : 5,
  "enable_client_ssl" : false
}

Example Responses

Status code: 200

{
  "protocol" : "http",
  "path" : "/vpc/demo",
  "method" : "GET",
  "port" : 22,
  "threshold_abnormal" : 5,
  "threshold_normal" : 2,
  "time_interval" : 10,
  "http_code" : "200",
  "enable_client_ssl" : false,
  "status" : 1,
  "timeout" : 5,
  "id" : "3b3d02026c5f402d85e8645ea95b0816",
  "vpc_channel_id" : "d38c55c926ca44c2bfb37886d93b9a0d",
  "create_time" : "2020-07-23T07:11:57Z"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: VPC Channel Management

Previous topic: Disabling Backend Servers in Batches

Next topic: Adding or Updating a Backend Server Group of a VPC Channel

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot