You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /应用型负载均衡/开发指南/API 参考/实例/DescribeLoadBalancerAttributes
DescribeLoadBalancerAttributes
最近更新时间：2024.10.11 18:10:07首次发布时间：2022.05.20 21:49:15
我的收藏

请求说明

API 名称：DescribeLoadBalancerAttributes。
API 域名：open.volcengineapi.com 。
API 描述：查询 ALB 实例的详细信息。

使用限制

节流限制：每秒最多提交 200 个 API 请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数 。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称，如 DescribeLoadBalancerAttributes 。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint否900表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数类型是否必选参数说明示例
LoadBalancerId
String
是
ALB 实例 ID。
alb-bp1b6c719dfa08ex****

返回参数

参数类型参数说明示例值
RequestId
String请求ID。20210811152539010225146063030****
LoadBalancerIdStringALB 实例ID。alb-bp1o94dp5i6ea****
LoadBalancerNameStringALB 实例的名称。alb-test1

AddressIpVersion

String

ALB 实例的 IP 类型。取值如下：

  • IPv4：IPv4 类型。

  • DualStack：IPv4&IPv6 双栈类型。

DualStack

Status

String

ALB 实例状态。

  • Active：运行中。
  • Provisioning：创建中。
  • Configuring：配置中。
  • Deleting：删除中。
  • CreateFailed：创建失败。
  • Inactive：已停止。

Active

DescriptionStringALB 实例的描述。测试实例
CreateTimeStringALB 实例的创建时间。2021-08-11T16:37:37Z
UpdateTimeStringALB 实例的最近操作时间。2021-08-11T16:37:37Z

Type

String

ALB 实例的类型。

  • public：表示创建一个公网 ALB 实例，系统会分配一个公网 IP 地址和一个私网 IP 地址，公网IP地址用于转发公网请求，私网 IP 地址用于转发私网请求。
  • private：表示创建一个私网 ALB 实例，系统会分配一个私网IP地址，仅用于转发私网请求。

private

VpcIdStringALB 实例所属的VPC ID。vpc-bp1aevy8sofi8mh1****
SubnetId（即将下线）		StringALB 实例所属的子网ID。subnet-bp12mw1f8k3jgy****
EipId （即将下线）		String公网 IP ID。eip-2fe698wsnj****oxruvtryndp
EniAddress （即将下线）		StringALB 实例的私网 IP 地址。172.XX.XX.33
EniId （即将下线）		StringALB 实例占用的网卡 ID。eni-2fe6rabqt8g****xruv8u8c9f
EipAddress （即将下线）		StringALB 实例的公网 IP 地址。10.XX.XX.27

BusinessStatus

String

ALB 实例是否被锁定。此值为空时，实例状态为正常。

  • Normal: 正常。
  • FinancialLocked: 被锁定。

FinancialLocked

LockReason

String

ALB 实例被冻结的原因。该参数只有实例处于 FinancialLocked 状态时有返回值。

  • Financial: 因欠费被锁定。
  • Security: 因安全被锁定。

Financial

OverdueTimeStringALB 实例的冻结时间。该参数只有实例处于 FinancialLocked 状态时有返回值。2021-08-11T16:37:37Z
DeletedTimeStringALB 实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。2021-08-11T16:37:37Z
LoadBalancerBillingTypeIntegerALB实例计费类型，当前仅支持按量计费。 1：LCU（默认值）性能容量单元1
EipStructALB 实例的公网IP的信息。具体请参见下表 EIP。-
ListenersArrayALB 实例中监听器的信息。具体请参见下表 Listeners 。-
AccessLogStructALB 实例中访问日志的信息。具体请参见下表 AccessLog 。-
TLSAccessLogStructALB 实例中访问日志的信息。具体请参见下表 TLSAccessLog。-
HealthLogStructALB 实例中健康检查日志的信息。具体请参见下表 HealthLog 。-
DNSNameStringDNS域名。alb-qwe1344.cn-beijing.volcalb.com
ZoneMappings		ArrayALB 实例在不同可用区下的配置信息。具体参见下表 ZoneMappings。-

DeleteProtection

String

ALB 实例的删除保护功能为开启或关闭状态。

  • off：删除保护功能为关闭状态。

  • on：删除保护功能为开启状态。

off

LocalAddressesArrayALB 实例的回源地址。["100.64.1.0/20", "xxx"]
ProjectNameString实例所属项目名称。default
TagsArray实例所属标签，具体参见下表 Tags。-

SniAutoMatch

String

实例是否支持自动选择扩展证书。

  • off：不支持自动选择扩展证书。

  • on：支持自动选择扩展证书。

off

WafProtectionEnabled

String

WAF 安全防护开关。

  • off：WAF 安全防护功能关闭 。

  • on：WAF 安全防护功能开启。

off

WafInstanceId

String

ALB 实例绑定的 WAF 安全防护实例的 ID 。

waf-14ca6f67c33c09****

GlobalAcceleratorsArrayALB 实例绑定的全球加速器，具体参见下表GlobalAccelerators。-

说明

SubnetId、EipId、EniAddress、EniId、EipAddress 字段即将下线，请使用 ZoneMappings 字段接入服务，指定需要部署的可用区和子网信息。

EIP

参数类型参数说明示例值
ISP

String

ALB 实例上的公网IP线路类型。

  • BGP：BGP (多线)。

BGP

EipBillingType

Integer

公网IP的计费方式。

  • 2，按量计费-按带宽上限计费（默认值）。
  • 3，按量计费-按实际流量计费。

2

BandwidthInteger公网IP的带宽峰值，单位为Mbps。10
EipAddressStringALB 实例的公网IP地址。10.XX.XX.27

SecurityProtectionTypes

Array

公网IP 的防护类型。具体取值如下：

  • AntiDDoS_Enhanced：增强防护类型的公网IP，可加入到 DDoS 原生防护实例。

  • 空值：基础防护类型的公网IP。

-

EipType

String

ALB 实例上的公网IP类型，支持取值：

  • 空：弹性公网IP。

  • anycast：Anycast弹性公网IP。

anycast

PopLocationsArrayALB 作为Anycast弹性公网IP的源站时，关联的接入点信息。仅绑定Anycast弹性公网IP时有效。具体参见下表 PopLocation 。-

AssociationMode

String

ALB 作为Anycast弹性公网IP的源站类型，仅绑定Anycast弹性公网IP时有效。支持取值：

  • Default：默认模式。

  • Normal：普通模式。

Default

PopLocation

参数

类型

参数说明

示例值

PopIdStringAnycast弹性公网IP的接入点ID。cn-beijing-pop
PopNameStringAnycast弹性公网IP的接入点名称。北京-接入点

Listeners

参数类型参数说明示例值
ListenerId
StringALB 实例中监听器的ID。lsn-2fea4ayvu2g3k5oxruuze****
ListenerNameStringALB 实例中监听器的名称。listener-1

AccessLog

参数类型参数说明示例值
Enabled

Boolean

是否开启访问日志功能。

  • true：已开启。
  • false：未开启。

true

BucketNameString存储七层访问日志的对象存储桶的名称。alb-tos

TLSAccessLog

参数类型参数说明示例值
Enabled

Boolean

是否开启访问日志投递TLS功能。

  • true：已开启。

  • false：未开启。

true

TopicIdString访问日志绑定的 TLS 主题 ID。topic-xxxxx
ProjectIdString访问日志绑定的 TLS 项目 ID。project-xxxx

HealthLog

参数类型参数说明示例值
Enabled

Boolean

是否开启访问日志功能。

  • true：已开启。
  • false：未开启。

true

TopicIdString健康检查日志绑定的 TLS 主题 ID。topic-xxxxx
ProjectIdString健康检查日志绑定的 TLS 项目 ID。project-xxxx

ZoneMappings

参数类型参数说明示例值
ZoneId		StringALB 实例所处的可用区cn-beijing-a
SubnetIdStringALB 实例在该可用区的子网ID。subnet-bp12mw1f8k3jgy****
LoadBalancerAddressesArrayALB 实例在该可用区的IP地址。具体参见下表 LoadBalancerAddresses 。-

LoadBalancerAddresses

参数类型参数说明示例值
EniAddress		StringALB 实例在该可用区的私网IP地址。172.XX.XX.33
EniIdStringALB 实例在该可用区占用的网卡ID。eni-2fe6rabqt8g****xruv8u8c9f
EipAddressStringALB 实例在该可用区的公网IP地址。10.XX.XX.27
EipIdStringALB 实例在该可用区的公网IP ID。eip-2fe698wsnj****oxruvtryndp
EipStructALB 实例在该可用区的公网IP的信息。具体参见表 Eip 。-

EniIpv6Address

String

IPv4&IPv6 双栈类型的 ALB 实例，在该可用区的 IPv6 地址。

2408:4005:XX:XX:200

Ipv6EipIdStringIPv4&IPv6 双栈类型的 ALB 公网实例，在该可用区的 IPv6 公网带宽 ID。eip-2fe698wsnj****oxruvtryndp

Ipv6Eip

Struct

IPv4&IPv6 双栈类型的 ALB 公网实例，在该可用区的 IPv6 公网带宽的信息。具体参见下表 Ipv6Eip 。

-

Ipv6Eip

参数

类型

参数说明

示例

ISP

String

公网ALB 实例的 IPv6 公网带宽的线路类型。支持选择如下：

  • BGP：BGP多线（默认值）。

BGP

BillingType

Integer

公网ALB 实例的 IPv6 公网带宽的计费类型。取值如下：

  • 2：按量计费-按带宽上限计费。

  • 3：按量计费-按实际流量计费（默认值）。

2

BandwidthInteger公网ALB 实例的IPv6公网带宽的带宽上限，单位为Mbps。200

Tags

参数类型参数说明示例
Key

String

用户标签的标签键。具体规则如下：

  • 长度限制为1～128个字符。

  • 大小写敏感。

  • 不能以volc:的任意大小写组合开头。

  • 不能以空格开头或结尾。

  • 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

  • 同一资源的标签键不允许重复。

key

Value

String

用户标签的标签键。具体规则如下：

  • 长度限制为1～128个字符。

  • 大小写敏感。

  • 不能以volc:的任意大小写组合开头。

  • 不能以空格开头或结尾。

  • 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

  • 同一资源的标签键不允许重复。

value

GlobalAccelerators

参数

类型

参数说明

示例

AcceleratorId

String

全球加速器 ID。

accinstance-VYjG****

AcceleratorName

String

全球加速器名称。

测试

示例

请求示例

GET /?Action=DescribeLoadBalancerAttributes&LoadBalancerId=alb-1g1f1c6ae****A7&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "DescribeLoadBalancerAttributes",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },    
    "Result": {
            "RequestId": "20210811183410010****4214202005AE9",
            "LoadBalancerId": "alb-1g1f1c6aevm****buxws5k0k3",
            "LoadBalancerName": "test",
            "Status": "Active",
            "Description": "test",
            "CreateTime": "2021-08-11T18:01:42Z",
            "UpdateTime": "2021-08-11T18:18:13Z",
            "Type": "public",
            "VpcId": "vpc-3tj9fo0uqy3****28rma",
            "SubnetId": "subnet-3tj9f****m3vj0x28rn5",
            "EipID": "eip-2fe698wsnj8c****ruvtryndp",
            "EipAddress": "10.XX.XX.17",
            "EniID": "eni-2fe6sjrih****5oxruw1c3d8b",
            "EniAddress": "172.XX.XX.172",
            "BusinessStatus": "",
            "LockReason": "",
            "OverdueTime": "",
            "DeletedTime": "",
            "LoadBalancerBillingType": 1,
            "AccessLog": {
                "Enabled": "true",
                "BucketName": "alb-tos",
            },
            "Eip": {
                "ISP": "BGP",
                "Bandwidth": 1,
                "EipBillingType": 0,
                "EipAddress": "10.XX.XX.17"
            },
            "Listeners": [
                {
                    "ListenerId": "lsn-2ff0ixt8****g5oxruw4bbqjt",
                    "ListenerName": "test"
                }
            ],
            "DNSName": "alb-t5aepy8j****7mrjdjavoc2c.cn-beijing.volcalb.com",
            "ZoneMappings": [
                {
                    "ZoneId": "cn-beijing-a",
                    "SubnetId": "subnet-274tv****duyo7fap8sc658ze",
                    "LoadBalancerAddresses": [
                        {
                            "EniAddress": "192.168.0.25",
                            "EniId": "eni-274js3****xhc7fap8ssed7qg",
                            "EipAddress": "",
                            "EipId": "",
                            "Eip": {
                                "ISP": "BGP",
                                "Bandwidth": 1,
                                "EipBillingType": 0,
                                "EipAddress": "10.XX.XX.17"，
                                "SecurityProtectionTypes": ["AntiDDoS_Enhanced"]
                            },
                        }
                    ]
                },
                {
                    "ZoneId": "cn-beijing-b",
                    "SubnetId": "subnet-274u****nb8xs7fap8t1odh1n",
                    "LoadBalancerAddresses": [
                        {
                            "EniAddress": "192.168.1.254",
                            "EniId": "eni-274j****c6zgg7fap8t05movj",
                            "EipAddress": "",
                            "EipId": "",
                            "Eip": {
                                "ISP": "BGP",
                                "Bandwidth": 1,
                                "EipBillingType": 0,
                                "EipAddress": "10.XX.XX.17"，
                                "SecurityProtectionTypes": ["AntiDDoS_Enhanced"]
                            },
                        }
                    ]
                }
            ]
     }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code

错误码

错误信息

错误描述

404InvalidLoadBalancer.NotFoundThe specified LoadBalancer does not exist.指定的 ALB 实例不存在。