Querying Health Checks
Function
This API is used to query all the health checks. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.
URI
GET /v2/{project_id}/elb/healthmonitors
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
marker |
No |
String |
Specifies the ID of the health check from which pagination query starts, that is, the ID of the last health check on the previous page. This parameter must be used with limit. |
limit |
No |
Integer |
Specifies the number of health checks on each page. If this parameter is not set, all health checks are queried by default. |
page_reverse |
No |
Boolean |
Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link. This parameter must be used with limit. |
id |
No |
String |
Specifies the health check ID. |
tenant_id |
No |
String |
Specifies the ID of the project where the health check is performed. The value contains a maximum of 255 characters. |
project_id |
No |
String |
Specifies the ID of the project to which the health check belongs. This parameter has the same meaning as tenant_id. |
name |
No |
String |
Specifies the health check name. The value contains a maximum of 255 characters. |
delay |
No |
Integer |
Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50. |
max_retries |
No |
Integer |
Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10. |
admin_state_up |
No |
Boolean |
Specifies the administrative status of the health check. The value can be true or false. The default value is true.
|
timeout |
No |
Integer |
Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.
NOTE:
You are advised to set the value less than that of parameter delay. |
type |
No |
String |
Specifies the health check protocol. The value can be TCP, UDP_CONNECT, or HTTP. |
monitor_port |
No |
Integer |
Specifies the port used for the health check. The value is left blank by default, indicating that the port of the backend server is used as the health check port. |
expected_codes |
No |
String |
Specifies the expected HTTP status code. The following options are available: A single value, such as 200 A list of values, such as 200,202 A value range, such as 200–204 This parameter takes effect only when the value of type is set to HTTP. The value contains a maximum of 64 characters.
NOTE:
This parameter is reserved. |
domain_name |
No |
String |
Specifies the domain name of HTTP requests during the health check. This parameter takes effect only when the value of type is set to HTTP. The value is left blank by default, indicating that the private IP address of the load balancer is used as the destination address of HTTP requests. The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter, for example: www.test.com. The value contains a maximum of 100 characters. |
url_path |
No |
String |
Specifies the HTTP request path for the health check. The default value is /. The value starts with a slash (/). This parameter takes effect only when the value of type is set to HTTP. An example value is /test. The value contains a maximum of 80 characters. |
http_method |
No |
String |
Specifies the HTTP request method. The default value is GET. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. This parameter takes effect only when the value of type is set to HTTP.
NOTE:
This parameter is reserved. |
Request
None
Response
Parameter |
Type |
Description |
---|---|---|
healthmonitors |
Array of Healthmonitors objects |
Lists the health checks. For details, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the health check ID. |
tenant_id |
String |
Specifies the ID of the project where the health check is performed. |
project_id |
String |
Specifies the ID of the project to which the health check belongs. This parameter has the same meaning as tenant_id. |
name |
String |
Specifies the health check name. |
delay |
Integer |
Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50. |
max_retries |
Integer |
Specifies the maximum number of retries. The value ranges from 1 to 10. |
max_retries_down |
Integer |
Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10. |
pools |
Array of Pools objects |
Lists the IDs of backend server groups associated with the health check. For details, see Table 6. |
admin_state_up |
Boolean |
Specifies the administrative status of the health check. This parameter is reserved. The value can be true or false.
|
timeout |
Integer |
Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.
NOTE:
You are advised to set the value less than that of parameter delay. |
type |
String |
Specifies the health check protocol. The value can be TCP, UDP_CONNECT, or HTTP. |
monitor_port |
Integer |
Specifies the health check port. The port number ranges from 1 to 65535. The value is left blank by default, indicating that the port of the backend server is used as the health check port. |
expected_codes |
String |
Specifies the expected HTTP status code. The following options are available: A single value, such as 200 A list of values, such as 200,202 A value range, such as 200–204 This parameter takes effect only when the value of type is set to HTTP. Currently, this parameter is not supported and is fixed at 200. |
domain_name |
String |
Specifies the domain name of HTTP requests during the health check. This parameter takes effect only when the value of type is set to HTTP. The value is left blank by default, indicating that the private IP address of the load balancer is used as the destination address of HTTP requests. The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter, for example: www.test.com. |
url_path |
String |
Specifies the HTTP request path for the health check. The default value is /. The value starts with a slash (/). This parameter takes effect only when the value of type is set to HTTP. An example value is /test. |
http_method |
String |
Specifies the HTTP request method. The default value is GET. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. This parameter takes effect only when the value of type is set to HTTP.
NOTE:
This parameter is reserved. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Specifies the ID of the backend server group. |
Example Request
- Example request 1: Querying all health checks
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors
- Example request 2: Querying HTTP health checks
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors?type=HTTP
Example Response
- Example response 1
{ "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200", "max_retries": 3, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] }
- Example response 2
{ "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200", "max_retries": 3, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] }
Status Code
For details, see Status Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot