负载均衡实例

列举负载均衡实例

功能介绍

查询负载均衡实例列表。

URI

GET /v2.0/octavia/amphorae

请求消息

参数	参数类型	是否必选	描述
fields	string	否	你想让服务器返回的字段。如果没有指定字段的查询参数，API会返回所有负载均衡实例的属性。通过使用`fields`参数，API只返回请求的属性集。可以指定多个字段的参数。例如，如果您指定`fields=id&fields=name`的请求URL，那么只有`id`和`name`属性将返回。

响应消息

参数	参数类型	描述
id	uuid	实例的ID。
loadbalancer_id	uuid	实例所属负载均衡器的ID。
compute_id	uuid	实例资源在计算服务中的ID。
lb_network_ip	string	实例的管理网IP。
vrrp_ip	string	实例的VRRP端口地址。
ha_ip	string	IP地址的虚拟IP (VIP)。
vrrp_port_id	uuid	vrrp端口ID的网络系统。
ha_port_id	uuid	实例的虚拟IP地址（VIP）。
cert_expiration	string	实例的证书过期日期。
cert_busy	string	实例的证书是否正在被替换。
role	string	实例的角色。取值为：STANDALONE、MASTER、BACKUP。
status	string	实例的状态。取值为：BOOTING、ALLOCATED、READY、PENDING_CREATE、PENDING_DELETE、DELETED、ERROR。
vrrp_interface	string	实例上VRRP端口的绑定接口名称。
vrrp_id	string	实例的VRRP组ID。
vrrp_priority	string	实例在VRRP组中的优先级。
cached_zone	string	计算实例的可用区，在创建时缓存。如果计算服务不使用可用区，则可能是空字符串。
created_at	string	实例创建的时间。
updated_at	string	实例最后一次更新的时间。
image_id	uuid	实例使用的镜像ID。
compute_flavor	string	实例使用的计算规格。

请求示例

curl -X GET "http://octavia-api.octavia.svc.cluster.local:9876/v2.0/octavia/amphorae?loadbalancer_id=7952e810-cfa0-4206-8ae3-594e3d0869e0"  -H "X-Auth-Token: <token>"

正常响应示例

{
  "amphorae": [
    {
      "id": "a83b8e75-935f-435d-ab6b-5f6534e0284e",
      "loadbalancer_id": "7952e810-cfa0-4206-8ae3-594e3d0869e0",
      "compute_id": "717f8cc0-40d8-476c-9f87-9fff2aadbf37",
      "lb_network_ip": "100.66.2.95",
      "vrrp_ip": "192.168.111.184",
      "ha_ip": "192.168.111.29",
      "vrrp_port_id": "2c74d9d4-e48f-4d15-bcb7-88cddb76aacc",
      "ha_port_id": "58da5cf6-9270-425e-b8fc-27da50fcd0b9",
      "cert_expiration": "2022-05-13T12:36:51",
      "cert_busy": false,
      "role": "BACKUP",
      "status": "ALLOCATED",
      "vrrp_interface": "eth1",
      "vrrp_id": 1,
      "vrrp_priority": 90,
      "cached_zone": "default-az",
      "created_at": "2022-05-31T12:36:51",
      "updated_at": "2022-04-13T12:38:47",
      "image_id": "cb8d5a80-8377-44cb-bdc1-d9a50277559a",
      "compute_flavor": "602"
    },
    {
      "id": "0af17591-8aca-45dc-a5ad-50356cb0cce1",
      "loadbalancer_id": "7952e810-cfa0-4206-8ae3-594e3d0869e0",
      "compute_id": "1c4b6036-e0c3-44f9-a1e8-436a81440d98",
      "lb_network_ip": "100.66.3.103",
      "vrrp_ip": "192.168.111.37",
      "ha_ip": "192.168.111.29",
      "vrrp_port_id": "1e705eba-0bd1-4d08-8047-2e2fc8fb0ebe",
      "ha_port_id": "58da5cf6-9270-425e-b8fc-27da50fcd0b9",
      "cert_expiration": "2022-05-13T12:37:50",
      "cert_busy": false,
      "role": "MASTER",
      "status": "ALLOCATED",
      "vrrp_interface": "eth1",
      "vrrp_id": 1,
      "vrrp_priority": 100,
      "cached_zone": "default-az",
      "created_at": "2022-04-13T12:37:50",
      "updated_at": "2022-04-13T12:38:47",
      "image_id": "cb8d5a80-8377-44cb-bdc1-d9a50277559a",
      "compute_flavor": "602"
    }
  ],
  "amphorae_links": []
}

正常响应代码

200

错误码

400，401，403，500

查询负载均衡实例详情

功能介绍

查询负载均衡实例详情。

URI

GET /v2.0/octavia/amphorae/{amphora_id}

参数	是否必选	描述
amphora_id	是	待查询的负载均衡实例ID。

请求消息

参数	参数类型	是否必选	描述
fields	string	否	你想让服务器返回的字段。如果没有指定字段的查询参数，API会返回所有负载均衡实例的属性。通过使用`fields`参数，API只返回请求的属性集。可以指定多个字段的参数。例如，如果您指定`fields=id&fields=name`的请求URL，那么只有`id`和`name`属性将返回。

响应消息

参数	参数类型	描述
id	uuid	实例的ID。
loadbalancer_id	uuid	实例所属负载均衡器的ID。
compute_id	uuid	实例资源在计算服务中的ID。
lb_network_ip	string	实例的管理网IP。
vrrp_ip	string	实例的VRRP端口地址。
ha_ip	string	实例的虚拟IP地址（VIP）。
vrrp_port_id	uuid	实例的VRRP端口ID。
ha_port_id	uuid	实例的虚拟IP端口ID。
cert_expiration	string	实例的证书过期日期。
cert_busy	string	实例的证书是否正在被替换。
role	string	实例的角色。取值为：STANDALONE、MASTER、BACKUP。
status	string	实例的状态。取值为：BOOTING、ALLOCATED、READY、PENDING_CREATE、PENDING_DELETE、DELETED、ERROR。
vrrp_interface	string	实例上VRRP端口的绑定接口名称。
vrrp_id	string	实例的VRRP组ID。
vrrp_priority	string	实例在VRRP组中的优先级。
cached_zone	string	计算实例的可用区，在创建时缓存。如果计算服务不使用可用区，则可能是空字符串。
created_at	string	实例创建的时间。
updated_at	string	实例最后一次更新的时间。
image_id	uuid	实例使用的镜像ID。
compute_flavor	string	实例使用的计算规格。

请求示例

curl -X GET http://octavia-api.octavia.svc.cluster.local:9876/v2.0/octavia/amphorae/a83b8e75-935f-435d-ab6b-5f6534e0284e  -H "X-Auth-Token: <token>"

正常响应示例

{
  "amphora": {
    "id": "a83b8e75-935f-435d-ab6b-5f6534e0284e",
    "loadbalancer_id": "7952e810-cfa0-4206-8ae3-594e3d0869e0",
    "compute_id": "717f8cc0-40d8-476c-9f87-9fff2aadbf37",
    "lb_network_ip": "100.66.2.95",
    "vrrp_ip": "192.168.111.184",
    "ha_ip": "192.168.111.29",
    "vrrp_port_id": "2c74d9d4-e48f-4d15-bcb7-88cddb76aacc",
    "ha_port_id": "58da5cf6-9270-425e-b8fc-27da50fcd0b9",
    "cert_expiration": "2022-05-13T12:36:51",
    "cert_busy": false,
    "role": "BACKUP",
    "status": "ALLOCATED",
    "vrrp_interface": "eth1",
    "vrrp_id": 1,
    "vrrp_priority": 90,
    "cached_zone": "default-az",
    "created_at": "2022-04-13T12:36:51",
    "updated_at": "2022-04-13T12:38:47",
    "image_id": "cb8d5a80-8377-44cb-bdc1-d9a50277559a",
    "compute_flavor": "602"
  }
}

正常响应代码

200

错误码

401，403，404，500

负载均衡实例故障转移

功能介绍****

重置负载均衡实例，完成故障转移。

URI

PUT /v2.0/octavia/amphorae/{amphora_id}/failover

参数	是否必选	描述
amphora_id	是	待故障转移的负载均衡实例ID。

请求消息

无

响应消息

无

请求示例

curl -X PUT http://octavia-api.octavia.svc.cluster.local:9876/v2.0/octavia/amphorae/a83b8e75-935f-435d-ab6b-5f6534e0284e/failover  -H "X-Auth-Token: <token>"

正常响应示例

无

正常响应代码

202

错误码

400，401，403，404，500