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

负载均衡

复制全文
下载 pdf
CLB实例
DescribeLoadBalancerAttributes - 查询负载均衡详细信息
复制全文
下载 pdf
DescribeLoadBalancerAttributes - 查询负载均衡详细信息
调用 DescribeLoadBalancerAttributes 接口,查看指定CLB实例的详情。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:DescribeLoadBalancerAttributes​
要执行的操作,取值:DescribeLoadBalancerAttributes。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
LoadBalancerId String 必选 示例值:clb-bp1b6c719dfa08ex****​
CLB实例ID。​
您可以调用DescribeLoadBalancers接口,查询CLB实例ID。​
​
​
​
返回参数​
RequestId String 示例值:202108161106382514606306AF947C****​
请求ID。​
​
AccountId String 示例值:210012****​
CLB实例所属的账号ID。​
​
ExclusiveClusterId String 示例值:ec-bp1o94dp5i6ea****​
独占集群的ID。​
非独占集群类型的CLB实例该参数返回为空。 独占集群正在邀测中,暂仅支持完成企业认证的账号申请试用,如需试用,请联系客户经理。​
​
LoadBalancerId String 示例值:clb-bp1b6c719dfa08ex****​
CLB实例ID。​
​
LoadBalancerName String 示例值:clb-test1​
CLB实例的名称。​
​
Description String 示例值:CLB-Description​
CLB实例的描述。​
​
Type String 示例值:private​
CLB实例的类型。​
  • public:公网。​
  • private:私网。​
​
AddressIpVersion String 示例值:ipv4​
CLB实例的IP地址类型。​
  • ipv4:仅IPv4。​
  • DualStack:双栈,即IPv4和IPv6。​
​
LoadBalancerBillingType Integer 示例值:2​
CLB实例计费类型。​
  • 1:包年包月​
  • 2:按量计费-按规格计费​
  • 3:按量计费-按使用量计费​
说明​
按使用量计费正在邀测中,如需试用,请联系客户经理。​
​
LoadBalancerSpec String 示例值:small_1​
CLB实例的规格。​
  • small_1:小型I​
  • small_2:小型II​
  • medium_1:中型I​
  • medium_2:中型II​
  • large_1:大型I​
  • large_2:大型II​
​
MasterZoneId String 示例值:cn-shanghai-a​
CLB实例的主可用区ID。​
​
SlaveZoneId String 示例值:cn-shanghai-b​
CLB实例的备可用区ID。​
CLB实例为单可用区实例时,该参数返回为空。 CLB单可用区正在邀测中,如需试用,请联系客户经理。​
​
VpcId String 示例值:vpc-bp1aevy8sofi8mh1****​
CLB实例所属的VPC ID。​
​
SubnetId String 示例值:subnet-bp12mw1f8k3jgy****​
CLB实例所属的子网ID。​
​
EniID String 示例值:eni-2fe6rabqt8gxruv8u8c9f****​
CLB实例占用的网卡ID。​
​
EipID String 示例值:eip-2fe698wsnjoxruvtryndp****​
公网IP的ID。​
​
EipAddress String 示例值:10.XX.XX.27​
CLB实例的公网IP地址。​
​
EniAddress String 示例值:172.XX.XX.33​
CLB实例的私网IPv4地址。​
​
EniAddressNum Integer 示例值:2​
CLB实例的私网IPv4地址数量。​
​
EniAddresses Object[] 示例值:172.XX.XX.2​
CLB实例的私网IPv4地址信息。​
EniAddress String 示例值:172.XX.XX.33​
CLB实例的私网IPv4地址。​
​
EipId String 示例值:eip-3ciyamhu46c6rrswwusg****​
私网IPv4地址绑定的公网IP的ID。​
​
EipAddress String 示例值:10.XX.XX.27​
私网IPv4地址绑定的公网IP地址。​
​
​
Eip Object 示例值:-​
CLB实例的公网IP的信息。​
ISP String 示例值:BGP​
CLB实例上的公网IP线路类型。​
  • BGP:BGP (多线)。​
  • ChinaMobile:中国移动静态单线。​
  • ChinaTelecom:中国电信静态单线。​
  • ChinaUnicom:中国联通静态单线。​
  • SingleLine_BGP:BGP单线。​
  • Static_BGP:静态BGP。​
说明​
除BGP(多线)外,其他线路类型均在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。​
​
EipBillingType Integer 示例值:2​
公网IP的计费方式。​
  • 1:包年包月计费​
  • 2:按量计费-按带宽上限计费​
  • 3:按量计费-按实际流量计费​
​
Bandwidth Integer 示例值:10​
公网IP的带宽峰值,单位为Mbps。​
​
EipAddress String 示例值:10.XX.XX.27​
CLB实例的公网IP地址。​
​
BandwidthPackageId String 示例值:bwp-2zeo05qre24nhrqpy****​
公网IP加入的共享带宽包的ID。​
​
SecurityProtectionTypes String[] 示例值:["AntiDDoS_Enhanced"]​
公网IP的安全防护类型。​
  • AntiDDoS_Enhanced:表示公网IP为增强防护类型,该公网IP可以加入到DDoS原生防护(企业版)实例。​
  • 空值:表示公网IP为基础防护类型。​
说明​
增强防护型公网IP正在邀测中,如果未开通该功能,则不会返回该参数。​
​
​
EniIpv6Address String 示例值:2408:4005:XX:XX:200​
CLB实例的私网IPv6地址。​
​
Ipv6EipId String 示例值:eip-2zaiwb7ujxscd****​
IPv6公网带宽的ID。​
​
Ipv6AddressBandwidth Object 示例值:-​
CLB实例的IPv6公网带宽信息。​
Bandwidth Integer 示例值:10​
IPv6公网带宽的带宽峰值,单位为Mbps。​
​
NetworkType String 示例值:public​
CLB实例IPv6地址的网络类型。​
  • public:表示该IPv6地址已开通公网带宽,可以转发IPv6公网流量。​
​
BillingType Integer 示例值:2​
IPv6公网带宽的计费方式。​
  • 2:按量计费-按带宽上限计费。​
  • 3:按量计费-按实际流量计费​
​
ISP String 示例值:BGP​
IPv6公网带宽的线路类型。​
  • BGP:BGP(多线)。​
​
BandwidthPackageId String 示例值:bwp-2zeo05qre24nhrqpy****​
IPv6公网带宽加入的共享带宽包的ID。​
​
​
ModificationProtectionStatus String 示例值:ConsoleProtection​
是否开启控制台修改保护。​
  • NonProtection或空:不开启。配置后会清空已配置的ModificationProtectionReason。​
  • ConsoleProtection:开启。开启后,禁止通过控制台修改实例或删除实例,但允许通过API接口修改或删除。​
​
ModificationProtectionReason String 示例值:托管实例​
设置修改保护状态的原因。​
说明​
仅在ModificationProtectionStatus为 ConsoleProtection时有效。​
​
ServiceManaged Boolean 示例值:false​
CLB实例是否为托管资源。​
  • true:托管资源。表示创建CLB以外的其他云资源时系统同步创建的CLB资源。​
  • false:非托管资源。表示在CLB侧手动创建的CLB资源。​
​
Status String 示例值:Active​
CLB实例状态。​
  • Inactive:已停止。​
  • Active:运行中。​
  • Creating:创建中。​
  • Provisioning:创建中。​
  • Configuring:配置中。​
  • Deleting:删除中。​
  • CreateFailed:创建失败。​
​
BusinessStatus String 示例值:FinancialLocked​
CLB实例是否被锁定。​
  • Normal: 正常。​
  • FinancialLocked: 被锁定。​
说明​
该参数返回为空时,表示实例未被锁定。​
​
LockReason String 示例值:Financial​
CLB实例被冻结的原因。该参数只有实例处于 FinancialLocked 状态时有返回值。​
  • Financial: 因欠费被锁定。​
说明​
参数BusinessStatus取值为“Normal”或空值时,该参数返回为空。​
​
Listeners Object[] 示例值:-​
CLB实例中监听器的信息。​
ListenerId String 示例值:lsn-2fea4ayvu2g3k5oxruuze****​
监听器的ID。​
​
ListenerName String 示例值:listener-1​
监听器的名称。​
​
​
ServerGroups Object[] 示例值:-​
CLB实例中后端服务器组的信息。​
ServerGroupId String 示例值:rsp-1g0ogy36a8t8g8ibuxwy5****​
后端服务器组的ID。​
​
ServerGroupName String 示例值:servergroup-1​
后端服务器组的名称。​
​
​
LogTopicId String 示例值:74936ae4-bbd6-41de-a0d2-ed156203****​
日志主题的ID。​
​
AccessLog Object 示例值:-​
CLB实例中访问日志的信息。​
Enabled Boolean 示例值:true​
是否开启访问日志(七层)投递至对象存储TOS的功能。​
  • true:已开启。​
  • false:未开启。​
​
BucketName String 示例值:clb-tos​
存储七层访问日志的对象存储桶的名称。​
​
TlsEnabled Boolean 示例值:true​
是否开启访问日志(七层)投递至日志服务TLS的功能。​
  • true:已开启。​
  • false:未开启。​
​
TlsProjectId String 示例值:fc6953c1-fe50-***​
日志项目。​
​
TlsTopicId String 示例值:74936ae4-bbd6-***​
日志主题。​
​
​
Enabled Boolean 示例值:true​
CLB实例的启用状态。​
  • true:表示启用。​
  • false:表示禁用。​
说明​
当CLB实例处于欠费关停或到期关停状态时,该参数值为“false”,其他情况下均为“true”。​
​
ProjectName String 示例值:default​
CLB实例所属项目的名称。​
​
Tags Object[] 示例值:-​
CLB实例的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
BypassSecurityGroupEnabled String 示例值:off​
CLB实例是否开启了“放通后端安全组”功能。​
  • on:开启。​
  • off:未开启。​
​
TimestampRemoveEnabled String 示例值:off​
是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。​
  • on:开启。​
  • off:不开启。​
说明​
本功能正在邀测中,如需试用,请联系客户经理。​
​
CreateTime String 示例值:2021-08-11T16:37:37Z​
CLB实例的创建时间。​
​
UpdateTime String 示例值:2021-08-11T16:37:37Z​
CLB实例的最近操作时间。​
​
OverdueTime String 示例值:2021-08-11T16:37:37Z​
CLB实例的冻结时间。​
说明​
参数BusinessStatus取值为“Normal”或空值时,该参数返回为空。​
​
DeletedTime String 示例值:2021-08-11T16:37:37Z​
CLB实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。​
​
ExpiredTime String 示例值:2021-08-11T23:59:59Z​
CLB实例到期时间。​
说明​
仅在参数LoadBalancerBillingType配置为1时,返回该参数。​
​
​
​
请求示例​
​
GET /?Action=DescribeLoadBalancerAttributes&LoadBalancerId=clb-bp1b6c719dfa08ex****&Version=2020-04-01 HTTP/1.1​
Host: clb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202108161106382514606306AF947C****",​
"Action": "DescribeLoadBalancerAttributes",​
"Version": "2020-04-01",​
"Service": "clb",​
"Region": "cn-shanghai"​
}, ​
"Result": {​
"RequestId": "202108161106382514606306AF947C****",​
"AccountId": "210012****",​
"ExclusiveClusterId": "",​
"LoadBalancerId": "clb-bp1b6c719dfa08ex****",​
"LoadBalancerName": "clb-test1",​
"Description": "测试实例",​
"Type": "public",​
"AddressIpVersion": "ipv4",​
"LoadBalancerBillingType": 2,​
"LoadBalancerSpec": "small_1",​
"MasterZoneId": "cn-shanghai-a",​
"SlaveZoneId": "cn-shanghai-b",​
"VpcId": "vpc-bp1aevy8sofi8mh1****",​
"SubnetId": "subnet-bp12mw1f8k3jgy****",​
"EniID": "eni-2fe6rabqt8gxruv8u8c9f****",​
"EipAddress": "10.XX.XX.27",​
"EniAddress": "172.XX.XX.33",​
"Eip": {​
"ISP": "BGP",​
"Bandwidth": 1,​
"EipBillingType": 2,​
"EipAddress": "10.XX.XX.27",​
"BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",​
"SecurityProtectionTypes": [​
"AntiDDoS_Enhanced"​
]​
},​
"EniIpv6Address": "2408:4005:XX:XX:200",​
"Ipv6EipId": "eip-2zaiwb7ujxscd****",​
"Ipv6AddressBandwidth": {​
"ISP": "BGP",​
"Bandwidth": 10,​
"EipBillingType": 2,​
"NetworkType": "public"​
},​
"ModificationProtectionStatus": "",​
"ModificationProtectionReason": "",​
"ServiceManaged": false,​
"Status": "Active",​
"BusinessStatus": "",​
"LockReason": "",​
"Enabled": true,​
"Listeners": [​
{​
"ListenerId": "lsn-2fea4ayvu2g3k5oxruuze****",​
"ListenerName": "listener-1"​
}​
],​
"ServerGroups": [​
{​
"ServerGroupId": "rsp-1g0ogy36a8t8g8ibuxwy5****",​
"ServerGroupName": "servergroup-1"​
}​
],​
"LogTopicId": "",​
"AccessLog": {​
"Enabled": true,​
"BucketName": "clb-tos",​
},​
"ProjectName": "default",​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
},​
{​
"Key": "volc:clb:k1",​
"Value": ""​
}​
],​
"TimestampRemoveEnabled": "off",​
"CreateTime": "2021-08-11T18:01:42Z",​
"UpdateTime": "2021-08-11T18:18:13Z",​
"OverdueTime": "",​
"DeletedTime": "" ​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'LoadBalancerId'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如 LoadBalancerId。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如 。​
403​
Forbidden​
You are not authorized to perform operations on the specified service.​
无权限对指定服务进行操作。​
404​
InvalidLoadBalancer.NotFound​
The specified LoadBalancer does not exist.​
指定的负载均衡不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.06.04 10:48:36
这个页面对您有帮助吗?
有用
有用
无用
无用