This is the multi-page printable view of this section. Click here to print.
CreateLBHealthCheck
1 - 1.3
scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]
Description
Create LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | LB Health Check Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
2 - 1.2
scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]
Description
Create LB Health Check
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | LB Health Check Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
3 - 1.1
scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]
Description
Create LB Health Check
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | LB Health Check Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |