获取负载均衡实例详情--边缘计算节点-火山引擎

文档中心

立即注册

导航

获取负载均衡实例详情

最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 10:22:47

本接口用于获取负载均衡实例的详情。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=GetLB7Instance&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetLB7Instance`	接口名称。当前 API 的名称为 `GetLB7Instance`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
lb7_identity	String	是	`veew-lb72422242200104404****`	负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。

返回参数

参数	类型	示例值	描述
lb7	Lb7	`见下文说明`	负载均衡实例的信息。

Lb7

参数	类型	示例值	描述
identity	String	`veew-lb72422242200104404****`	负载均衡实例的 ID。
name	String	`lb-veen01`	负载均衡实例的名称。
rs_type	Integer	`1`	后端服务器的类型： 1：边缘实例。 2：边缘容器。
status	Integer	`2`	负载均衡实例的状态： 1：变更中。 2：运行中。 3：删除中。
vpc_identity	String	`vpc-pv5vj2****`	负载均衡实例所属私有网络的 ID。该参数只适用于以下场景：后端服务器为边缘实例。
vpc_name	String	`**移动02-默认VPC`	负载均衡实例所属私有网络的名称。该参数只适用于以下场景：后端服务器为边缘实例。
eip_type	Integer	`1`	负载均衡实例绑定的弹性公网 IP 的类型： 1：IPv4。
billing_mode	Integer	`255`	带宽计费方式。后端服务器为边缘实例： 255：按照绑定的弹性公网 IP 计费。后端服务器为边缘容器： 1：按月 95 峰值计费。 2：按日峰值计费。
desc	String	`dev`	负载均衡实例的描述。
network_type	Integer	`1`	负载均衡实例的网络类型： 1：公网。
eips	[]Eips	`见下文说明`	绑定的弹性公网 IP 的列表。
qps	Integer	`2000`	每秒能够处理的请求的数量（QPS）。
is_empty	Boolean	`false`	负载均衡实例下是否存在监听器： true：不存在监听器。 false：存在监听器。
application_identity	String	`veecc-255622122036230****`	边缘应用的 ID。该参数只适用于以下场景：后端服务器为边缘容器。
application_name	String	`app01`	边缘应用的名称。该参数只适用于以下场景：后端服务器为边缘容器。
create_time	Long	`1716454666`	负载均衡实例的创建时间，以 UNIX 时间戳格式显示。单位：秒。
update_time	Long	`1716895820`	负载均衡实例的更新时间，以 UNIX 时间戳格式显示。单位：秒。
clusters	[]Clusters	`见下文说明`	后端服务器为边缘实例时，该参数指负载均衡实例所在的节点。后端服务器为边缘容器时，该参数指边缘应用的部署节点。
bandwidth_peak	Long	`500`	带宽峰值。单位：Mbps。该参数只适用于以下场景：后端服务器为边缘容器。

Eips

参数	类型	示例值	描述
identity	String	`eip-nxsmj5****`	弹性公网 IP 的 ID。
eip_addr	String	`42...201`	弹性公网 IP 地址。
bandwidth_peak	Long	`500`	弹性公网 IP 的带宽峰值。单位：Mbps。
cluster_name	String	`**cm05`	弹性公网 IP 所在的节点。

Clusters

参数	类型	示例值	描述
cluster_name	String	`**cm05`	节点的名称。
cluster_alias	String	`**移动05`	节点的中文名称。
region	String	`CentralChina`	区域。
city	String	`410100`	城市。
isp	String	`CMCC`	运营商。

请求示例

POST https://veenedge.volcengineapi.com/?Action=GetLB7Instance&Version=2021-04-30
{
    "lb7_identity": "veew-lb70204100444012074****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240614175058552B20FB9E2D3016****",
        "Action": "GetLB7Instance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "lb7": {
            "identity": "veew-lb70204100444012074****",
            "name": "lb-veen01",
            "country": null,
            "region": null,
            "province": null,
            "city": null,
            "isp": null,
            "alias": null,
            "rs_type": 1,
            "status": 2,
            "vpc_identity": "vpc-8w7kvb****",
            "vpc_name": "**ct05-默认VPC",
            "eip_type": 1,
            "billing_mode": 255,
            "payment_method": 0,
            "desc": "dev",
            "network_type": 1,
            "listeners": [],
            "eips": [
                {
                    "identity": "eip-7cjc6q****",
                    "eip_addr": "9.**.**.218",
                    "bandwidth_peak": 20,
                    "cluster_name": "**ct05",
                    "name": null,
                    "eip_type": null,
                    "region": null,
                    "city": null,
                    "isp": null,
                    "cluster_alias": null,
                    "status": null
                }
            ],
            "qps": 2000,
            "is_empty": false,
            "application_identity": "",
            "application_name": null,
            "create_time": 1718347447,
            "update_time": 1718356504,
            "clusters": [
                {
                    "cluster_name": "**ct05",
                    "cluster_alias": "**电信05",
                    "region": "EastChina",
                    "city": "330200",
                    "isp": "CTCC"
                }
            ],
            "bandwidth_peak": 0
        }
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。