API 名称:DescribeLoadBalancerAttributes。
API 域名:open.volcengineapi.com 。
API 描述:查询 ALB 实例的详细信息。
节流限制:每秒最多提交 200 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数 。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称,如 DescribeLoadBalancerAttributes 。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
X-Expires | int | 否 | 900 | 表示签名的有效时间,单位是秒,默认值是900。 |
在使用该 API 提交请求时,请求参数中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
LoadBalancerId | String | 是 | ALB 实例 ID。 | alb-bp1b6c719dfa08ex**** |
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
RequestId | String | 请求ID。 | 20210811152539010225146063030**** |
LoadBalancerId | String | ALB 实例ID。 | alb-bp1o94dp5i6ea**** |
LoadBalancerName | String | ALB 实例的名称。 | alb-test1 |
AddressIpVersion | String | ALB 实例的 IP 类型。取值如下:
| DualStack |
Status | String | ALB 实例状态。
| Active |
Description | String | ALB 实例的描述。 | 测试实例 |
CreateTime | String | ALB 实例的创建时间。 | 2021-08-11T16:37:37Z |
UpdateTime | String | ALB 实例的最近操作时间。 | 2021-08-11T16:37:37Z |
Type | String | ALB 实例的类型。
| private |
VpcId | String | ALB 实例所属的VPC ID。 | vpc-bp1aevy8sofi8mh1**** |
SubnetId(即将下线) | String | ALB 实例所属的子网ID。 | subnet-bp12mw1f8k3jgy**** |
EipId (即将下线) | String | 公网 IP ID。 | eip-2fe698wsnj****oxruvtryndp |
EniAddress (即将下线) | String | ALB 实例的私网 IP 地址。 | 172.XX.XX.33 |
EniId (即将下线) | String | ALB 实例占用的网卡 ID。 | eni-2fe6rabqt8g****xruv8u8c9f |
EipAddress (即将下线) | String | ALB 实例的公网 IP 地址。 | 10.XX.XX.27 |
BusinessStatus | String | ALB 实例是否被锁定。此值为空时,实例状态为正常。
| FinancialLocked |
LockReason | String | ALB 实例被冻结的原因。该参数只有实例处于 FinancialLocked 状态时有返回值。
| Financial |
OverdueTime | String | ALB 实例的冻结时间。该参数只有实例处于 FinancialLocked 状态时有返回值。 | 2021-08-11T16:37:37Z |
DeletedTime | String | ALB 实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。 | 2021-08-11T16:37:37Z |
LoadBalancerBillingType | Integer | ALB实例计费类型,当前仅支持按量计费。 1:LCU(默认值)性能容量单元 | 1 |
Eip | Struct | ALB 实例的公网IP的信息。具体请参见下表 EIP。 | - |
Listeners | Array | ALB 实例中监听器的信息。具体请参见下表 Listeners 。 | - |
AccessLog | Struct | ALB 实例中访问日志的信息。具体请参见下表 AccessLog 。 | - |
TLSAccessLog | Struct | ALB 实例中访问日志的信息。具体请参见下表 TLSAccessLog。 | - |
HealthLog | Struct | ALB 实例中健康检查日志的信息。具体请参见下表 HealthLog 。 | - |
DNSName | String | DNS域名。 | alb-qwe1344.cn-beijing.volcalb.com |
ZoneMappings | Array | ALB 实例在不同可用区下的配置信息。具体参见下表 ZoneMappings。 | - |
DeleteProtection | String | ALB 实例的删除保护功能为开启或关闭状态。
| off |
LocalAddresses | Array | ALB 实例的回源地址。 | ["100.64.1.0/20", "xxx"] |
ProjectName | String | 实例所属项目名称。 | default |
Tags | Array | 实例所属标签,具体参见下表 Tags。 | - |
说明
SubnetId、EipId、EniAddress、EniId、EipAddress 字段即将下线,请使用 ZoneMappings 字段接入服务,指定需要部署的可用区和子网信息。
EIP
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
ISP
|
String
| ALB 实例上的公网IP线路类型。
| BGP
|
EipBillingType | Integer | 公网IP的计费方式。
| 2 |
Bandwidth | Integer | 公网IP的带宽峰值,单位为Mbps。 | 10 |
EipAddress | String | ALB 实例的公网IP地址。 | 10.XX.XX.27 |
SecurityProtectionTypes | Array | 公网IP 的防护类型。具体取值如下:
| - |
EipType | String | ALB 实例上的公网IP类型,支持取值:
| anycast |
PopLocations | Array | ALB 作为Anycast弹性公网IP的源站时,关联的接入点信息。仅绑定Anycast弹性公网IP时有效。具体参见下表 PopLocation 。 | - |
AssociationMode | String | ALB 作为Anycast弹性公网IP的源站类型,仅绑定Anycast弹性公网IP时有效。支持取值:
| Default |
PopLocation
参数
|
类型
|
参数说明
|
示例值 |
---|---|---|---|
PopId | String | Anycast弹性公网IP的接入点ID。 | cn-beijing-pop |
PopName | String | Anycast弹性公网IP的接入点名称。 | 北京-接入点 |
Listeners
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
ListenerId | String | ALB 实例中监听器的ID。 | lsn-2fea4ayvu2g3k5oxruuze**** |
ListenerName | String | ALB 实例中监听器的名称。 | listener-1 |
AccessLog
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
Enabled
| Boolean
| 是否开启访问日志功能。
| true |
BucketName | String | 存储七层访问日志的对象存储桶的名称。 | alb-tos |
TLSAccessLog
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
Enabled
|
Boolean
| 是否开启访问日志投递TLS功能。
|
true |
TopicId | String | 访问日志绑定的 TLS 主题 ID。 | topic-xxxxx |
ProjectId | String | 访问日志绑定的 TLS 项目 ID。 | project-xxxx |
HealthLog
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
Enabled
| Boolean
| 是否开启访问日志功能。
| true |
TopicId | String | 健康检查日志绑定的 TLS 主题 ID。 | topic-xxxxx |
ProjectId | String | 健康检查日志绑定的 TLS 项目 ID。 | project-xxxx |
ZoneMappings
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
ZoneId | String | ALB 实例所处的可用区 | cn-beijing-a |
SubnetId | String | ALB 实例在该可用区的子网ID。 | subnet-bp12mw1f8k3jgy**** |
LoadBalancerAddresses | Array | ALB 实例在该可用区的IP地址。具体参见下表 LoadBalancerAddresses 。 | - |
LoadBalancerAddresses
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
EniAddress | String | ALB 实例在该可用区的私网IP地址。 | 172.XX.XX.33 |
EniId | String | ALB 实例在该可用区占用的网卡ID。 | eni-2fe6rabqt8g****xruv8u8c9f |
EipAddress | String | ALB 实例在该可用区的公网IP地址。 | 10.XX.XX.27 |
EipId | String | ALB 实例在该可用区的公网IP ID。 | eip-2fe698wsnj****oxruvtryndp |
Eip | Struct | ALB 实例在该可用区的公网IP的信息。具体参见表 Eip 。 | - |
EniIpv6Address | String | IPv4&IPv6 双栈类型的 ALB 实例,在该可用区的 IPv6 地址。 | 2408:4005:XX:XX:200 |
Ipv6EipId | String | IPv4&IPv6 双栈类型的 ALB 公网实例,在该可用区的 IPv6 公网带宽 ID。 | eip-2fe698wsnj****oxruvtryndp |
Ipv6Eip | Struct | IPv4&IPv6 双栈类型的 ALB 公网实例,在该可用区的 IPv6 公网带宽的信息。具体参见下表 Ipv6Eip 。 | - |
Ipv6Eip
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
ISP | String |
公网ALB 实例的 IPv6 公网带宽的线路类型。支持选择如下:
| BGP |
BillingType | Integer | 公网ALB 实例的 IPv6 公网带宽的计费类型。取值如下:
| 2 |
Bandwidth | Integer | 公网ALB 实例的IPv6公网带宽的带宽上限,单位为Mbps。 | 200 |
Tags
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
Key | String | 用户标签的标签键。具体规则如下:
| key |
Value | String | 用户标签的标签键。具体规则如下:
| value |
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": null } ] }, { "ZoneId": "cn-beijing-b", "SubnetId": "subnet-274u****nb8xs7fap8t1odh1n", "LoadBalancerAddresses": [ { "EniAddress": "192.168.1.254", "EniId": "eni-274j****c6zgg7fap8t05movj", "EipAddress": "", "EipId": "", "Eip": null } ] } ] } }
如果响应正文包含 Error 字段,则表示 API 请求失败。此处仅展示当前 API 的错误码,更多错误码请参见公共错误码。
HTTP Code | 错误码 | 错误信息 | 错误描述 |
---|---|---|---|
404 | InvalidLoadBalancer.NotFound | The specified LoadBalancer does not exist. | 指定的 ALB 实例不存在。 |