You need to enable JavaScript to run this app.
文档中心
负载均衡

负载均衡

复制全文
下载 pdf
实例
DescribeLoadBalancerAttributes - 查询 ALB 实例的详细信息
复制全文
下载 pdf
DescribeLoadBalancerAttributes - 查询 ALB 实例的详细信息
调用 DescribeLoadBalancerAttributes 接口,查看ALB 实例详情。​
使用说明​
每秒最多提交 200 个 API 请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeLoadBalancerAttributes​
要执行的操作,取值:DescribeLoadBalancerAttributes。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
LoadBalancerId string 必选 示例值:alb-bp1b608ex****​
ALB 实例 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId string 示例值:202125146063030****​
请求ID。​
​
LoadBalancerId string 示例值:alb-bp1o94dp5i6ea****​
ALB 实例ID。​
​
LoadBalancerName string 示例值:alb-test1​
ALB 实例的名称。​
​
AddressIpVersion string 示例值:DualStack​
ALB 实例的 IP 类型。​
  • IPv4:IPv4 类型。​
  • DualStack:IPv4&IPv6 双栈类型。​
​
Status string 示例值:Active​
ALB 实例状态。​
  • Active:运行中。​
  • Provisioning:创建中。​
  • Configuring:配置中。​
  • Deleting:删除中。​
  • CreateFailed:创建失败。​
  • Inactive:已停止。​
​
Description string 示例值:Test​
ALB 实例的描述。​
​
CreateTime string 示例值:2021-08-11T16:37:37Z​
ALB 实例的创建时间。​
​
UpdateTime string 示例值:2021-08-11T16:37:37Z​
ALB 实例的最近操作时间。​
​
Type string 示例值:private​
ALB 实例的类型。​
  • public:公网ALB。​
  • private:私网ALB。​
​
VpcId string 示例值:vpc-bp1aevy8sofi8mh1****​
ALB 实例所属的VPC ID。​
​
SubnetId string 示例值:subnet-bp11f8k3jgy****​
ALB 实例所属的子网ID。​
说明​
本参数即将下线,请使用 ZoneMappings 字段。​
​
EipId string 示例值:eip-2fe698wsddsnj****​
公网 IP ID。​
说明​
本参数即将下线,请使用 ZoneMappings 字段。​
​
EniAddress string 示例值:172.XX.XX.33​
ALB 实例的私网 IP 地址。​
说明​
本参数即将下线,请使用 ZoneMappings 字段。​
​
EniId string 示例值:eni-2fe6rabddqt8g****​
ALB 实例占用的网卡 ID。​
说明​
本参数即将下线,请使用 ZoneMappings 字段。​
​
EipAddress string 示例值:10.XX.XX.27​
ALB 实例的公网 IP 地址。​
说明​
本参数即将下线,请使用 ZoneMappings 字段。​
​
BusinessStatus string 示例值:FinancialLocked​
ALB 实例是否被锁定。此值为空时,实例状态为正常。​
  • Normal: 正常。​
  • FinancialLocked: 被锁定。​
​
LockReason string 示例值:Financial​
ALB 实例被冻结的原因。该参数只有实例处于 FinancialLocked 状态时有返回值。​
  • Financial: 因欠费被锁定。​
  • Security: 因安全被锁定。​
​
OverdueTime string 示例值:2021-08-11T16:37:37Z​
ALB 实例的冻结时间。该参数只有实例处于 FinancialLocked 状态时有返回值。​
​
DeletedTime string 示例值:2021-08-11T16:37:37Z​
ALB 实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。​
​
LoadBalancerBillingType integer 示例值:1​
ALB实例计费方式。​
1:LCU性能容量单元​
​
Eip object 示例值:-​
ALB 实例的公网IP的信息。​
ISP string 示例值:BGP​
ALB 实例上的公网IP线路类型。​
  • BGP:BGP多线。​
​
EipBillingType integer 示例值:2​
公网IP的计费方式。​
  • 2:按带宽上限计费 。​
  • 3:按实际流量计费。​
​
Bandwidth integer 示例值:10​
公网IP的带宽峰值,单位为Mbps。​
​
EipAddress string 示例值:10.XX.XX.27​
负载均衡实例的公网IP地址。​
​
SecurityProtectionTypes string[] 示例值:-​
公网IP 的防护类型。​
  • AntiDDoS_Enhanced:增强防护类型的公网IP,可加入到 DDoS 原生防护实例。​
  • 空值:基础防护类型的公网IP。​
​
EipType string 示例值:anycast​
ALB 实例上的公网IP类型。​
  • 空:公网IP。​
  • anycast:Anycast公网IP。​
​
PopLocations object[] 示例值:-​
ALB 作为Anycast公网IP的源站时,关联的接入点信息。​
PopId string 示例值:cn-beijing-pop​
Anycast公网IP的接入点ID。​
​
PopName string 示例值:beijing-pop​
Anycast公网IP的接入点名称。​
​
​
AssociationMode string 示例值:Default​
ALB 作为Anycast公网IP的源站类型,仅绑定Anycast公网IP时有效。​
  • Default:默认模式。​
  • Normal:普通模式。​
​
​
Listeners object[] 示例值:-​
ALB 实例中监听器的信息。​
ListenerId string 示例值:lsn-2fea4ayvu2g3k5oxruuze****​
ALB 实例中监听器的ID。​
​
ListenerName string 示例值:listener-1​
ALB 实例中监听器的名称。​
​
​
AccessLog object 示例值:-​
ALB 实例中访问日志的信息。​
BucketName string 示例值:alb-tos​
存储七层访问日志的对象存储桶的名称。​
​
Enabled boolean 示例值:true​
是否开启访问日志功能。​
  • true:已开启。​
  • false:未开启。​
​
​
TLSAccessLog object 示例值:-​
ALB 实例中访问日志的信息。​
Enabled boolean 示例值:true​
是否开启访问日志投递TLS功能。​
  • true:已开启。​
  • false:未开启。​
​
ProjectId string 示例值:project-xxxx​
访问日志绑定的 TLS 项目 ID。​
​
TopicId string 示例值:topic-xxxxx​
访问日志绑定的 TLS 主题 ID。​
​
​
HealthLog object 示例值:-​
ALB 实例中健康检查日志的信息。​
Enabled boolean 示例值:true​
是否开启访问日志功能。​
  • true:已开启。​
  • false:未开启。​
​
ProjectId string 示例值:project-xxxx​
健康检查日志绑定的 TLS 项目 ID。​
​
TopicId string 示例值:topic-xxxxx​
健康检查日志绑定的 TLS 主题 ID。​
​
​
DNSName string 示例值:alb-qwe1344.cn-beijing.volcenginealb.com​
DNS域名。​
​
ZoneMappings object[] 示例值:-​
ALB 实例在不同可用区下的配置信息。​
ZoneId string 示例值:cn-beijing-a​
ALB 实例所处的可用区​
​
SubnetId string 示例值:subnet-bp12mw1f8k3jgy****​
ALB 实例在该可用区的子网ID。​
​
LoadBalancerAddresses object[] 示例值:-​
ALB 实例在该可用区的IP地址。​
Ipv4LocalAddresses string[] 示例值:["172.XX.XX.34","172.XX.XX.35"]​
IPv4 Local 地址列表。ALB 与后端服务交互使用的地址列表。​
​
Ipv6LocalAddresses string[] 示例值:["2408:4005:XX:XX:201","2408:4005:XX:XX:202"]​
IPv6 Local 地址列表。ALB 与后端服务交互使用的地址列表。​
​
EniAddress string 示例值:172.XX.XX.33​
ALB 实例在该可用区的私网IP地址。​
​
EniId string 示例值:eni-2fe6rabqt8g****xruv8u8c9f​
ALB 实例在该可用区占用的网卡ID。​
​
EipAddress string 示例值:10.XX.XX.27​
ALB 实例在该可用区的公网IP地址。​
​
EipId string 示例值:eip-2fe698wsnj****oxruvtryndp​
ALB 实例在该可用区的公网IP ID。​
​
Eip object 示例值:-​
ALB 实例在该可用区的公网IP的信息。​
ISP string 示例值:BGP​
ALB 实例上的公网IP线路类型。​
  • BGP:BGP多线。​
​
EipBillingType integer 示例值:2​
公网IP的计费方式。​
  • 2:按带宽上限计费 。​
  • 3:按实际流量计费。​
​
Bandwidth integer 示例值:10​
公网IP的带宽峰值,单位为Mbps。​
​
EipAddress string 示例值:10.XX.XX.27​
负载均衡实例的公网IP地址。​
​
SecurityProtectionTypes string[] 示例值:-​
公网IP 的防护类型。​
  • AntiDDoS_Enhanced:增强防护类型的公网IP,可加入到 DDoS 原生防护实例。​
  • 空值:基础防护类型的公网IP。​
​
EipType string 示例值:anycast​
ALB 实例上的公网IP类型。​
  • 空:公网IP。​
  • anycast:Anycast公网IP。​
​
PopLocations object[] 示例值:-​
ALB 作为Anycast公网IP的源站时,关联的接入点信息。仅绑定Anycast公网IP时有效。​
PopId string 示例值:cn-beijing-pop​
Anycast公网IP的接入点ID。​
​
PopName string 示例值:beijing-pop​
Anycast公网IP的接入点名称。​
​
​
AssociationMode string 示例值:Default​
ALB 作为Anycast公网IP的源站类型,仅绑定Anycast公网IP时有效。​
  • Default:默认模式。​
  • Normal:普通模式。​
​
​
EniIpv6Address string 示例值:2408:4005:XX:XX:200​
IPv4&IPv6 双栈类型的 ALB 实例,在该可用区的 IPv6 地址。​
​
Ipv6EipId string 示例值:eip-2fe698wsnj****oxruvtryndp​
IPv4&IPv6 双栈类型的 ALB 公网实例,在该可用区的 IPv6 公网带宽 ID。​
​
Ipv6Eip object 示例值:-​
IPv4&IPv6 双栈类型的 ALB 公网实例,在该可用区的 IPv6 公网带宽的信息。​
Bandwidth integer 示例值:200​
公网ALB 实例的IPv6公网带宽的带宽上限,单位为Mbps。​
​
BillingType integer 示例值:2​
公网ALB 实例的 IPv6 公网带宽的计费类型。​
  • 2:按量计费-按带宽上限计费。​
  • 3:按量计费-按实际流量计费。​
​
ISP string 示例值:BGP​
公网ALB 实例的 IPv6 公网带宽的线路类型。​
  • BGP:BGP多线。​
​
​
​
​
DeleteProtection string 示例值:off​
ALB 实例的删除保护功能为开启或关闭状态。​
  • off:关闭。​
  • on:开启。​
​
LocalAddresses string[] 示例值:["100.64.1.0/20", "xxx"]​
ALB 实例的回源地址。​
​
ProjectName string 示例值:default​
实例所属项目名称。​
​
Tags object[] 示例值:-​
实例所属标签。​
Key string 示例值:key​
用户标签的标签键。​
​
Value string 示例值:value​
用户标签的标签值。​
​
​
SniAutoMatch string 示例值:off​
实例是否支持自动选择扩展证书。​
  • off:不支持。​
  • on:支持。​
​
WafProtectionEnabled string 示例值:off​
WAF 安全防护开关。​
  • off:关闭 。​
  • on:开启。​
​
WafInstanceId string 示例值:waf-14ca6f67c33c0****​
ALB 实例绑定的 WAF 安全防护实例的 ID 。​
​
GlobalAccelerators object[] 示例值:-​
ALB 实例绑定的全球加速器。​
AcceleratorId string 示例值:accinstance-VYjG****​
全球加速 ID。​
​
AcceleratorName string 示例值:global-test​
全球加速器名称。​
​
​
ModificationProtectionStatus string 示例值:NonProtection​
是否启用了实例修改保护功能。​
  • NonProtection:未启用。​
  • ConsoleProtection:已启用。​
​
ModificationProtectionReason string 示例值:This is modification protection​
启用实例修改保护的原因。​
​
LoadBalancerEdition string 示例值:Standard​
ALB 实例的版本:​
  • Basic:基础版。​
  • Standard:标准版。​
​
Enabled boolean 示例值:true​
实例的启用状态。​
  • true:表示启用。​
  • false:表示禁用。​
  • 只有当实例处于欠费关停或到期关停时,实例启用状态为false。​
​
SecurityGroupIds string[] 示例值:["sg-bp67acfmxazb4p****"]​
ALB 实例关联的安全组 ID。​
​
ArkClawEnabled string 示例值:off​
是否开启 ArkClaw 功能。​
  • on:开启。​
  • off:不开启。​
说明​
本参数正在邀测中,如需试用,请联系客户经理。​
​
SpaceNetworkId string 示例值:csn-bpkdt37pq72zv\*\*\*\*​
ArkClaw 实例所在 SpaceNetwork 的 ID。​
说明​
本参数正在邀测中,如需试用,请联系客户经理。​
​
​
​
请求示例​
​
GET /?Action=DescribeLoadBalancerAttributes&LoadBalancerId=alb-1g1f1c6ae****A7&Version=2020-04-01 HTTP/1.1​
Host: alb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"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"]​
},​
}​
]​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
Invalid%s.Malformed​
MismatchThe specified %s is malformed.​
指定的 %s 参数格式不合法。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: %s。​
400​
InvalidParameter​
Data unmarshal failed.​
请求解析失败。​
404​
InvalidLoadBalancer.NotFound​
The specified LoadBalancer does not exist.​
指定的 ALB 实例不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。请稍后重试或联系工程师进一步咨询。​
​
​
最近更新时间:2026.07.06 20:39:00
这个页面对您有帮助吗?
有用
有用
无用
无用