Object Model
This section describes the object models for VPC channel management.
- Operation Type indicates the operation that can be performed on a field.
C: create; U: update; R: read
- Mandatory indicates whether a field with the Operation Type of C is mandatory.
Parameter | Type | Description | Operation Type | Mandatory |
|---|---|---|---|---|
id | String | VPC channel ID | R | - |
name | String | VPC channel name | CRU | Yes |
type | Integer | VPC channel type, which can be:
| CRU | Yes |
status | Integer | VPC channel status, which can be:
| R | Yes |
project_id | String | Tenant ID | CRU | Yes |
port | Integer | Port number | CR | Yes |
balance_strategy | Integer | Distribution algorithm, which can be:
| CRU | Yes |
create_time | Timestamp | Time when the VPC channel is created | R | Yes |
Parameter | Type | Description | Operation Type | Mandatory |
|---|---|---|---|---|
id | String | Health check ID | R | - |
vpc_id | String | VPC channel ID | CRU | Yes |
protocol | String | Protocol for health checks, which can be:
| CRU | Yes |
path | Integer | Path for health checks, which is valid only when protocol is set to http | CRU | No |
port | Integer | Port number. The port number of the VPC channel will be used if no value is specified. | CRU | No |
threshold_normal | Integer | Healthy threshold | CRU | Yes |
threshold_abnormal | Integer | Unhealthy threshold | CRU | Yes |
time_out | Integer | Timeout to wait for a response | CRU | Yes |
time_interval | Integer | Interval between consecutive checks | CRU | Yes |
http_code | String | Success codes, which are valid only when protocol is set to http | CRU | No |
create_time | Timestamp | Time when the health check configuration is created | R | Yes |
Parameter | Type | Description | Operation Type | Mandatory |
|---|---|---|---|---|
id | String | Backend instance object ID | R | - |
vpc_id | String | VPC channel ID | CRU | Yes |
ext_vpc_id | String | ID of the VPC associated with the backend instance object This parameter is not used currently. | R | Yes |
instance_id | String | Instance ID | CRU | No |
instance_name | String | Instance name | CRU | No |
host | String | IP address of the backend instance object | CRU | Yes |
status | Integer | Status of the backend instance object
| R | Yes |
weight | Integer | Weight | CRU | Yes |
create_time | Timestamp | Time when the member is created | R | Yes |