You need to enable JavaScript to run this app.
导航

DescribeLoadBalancerAttributes

最近更新时间2024.03.22 17:30:50

首次发布时间2021.08.31 10:37:27

调用 DescribeLoadBalancerAttributes 接口查询指定负载均衡实例的详细信息。

调试

请求参数

名称类型是否必填示例值
描述
ActionStringDescribeLoadBalancerAttributes要执行的操作,取值为DescribeLoadBalancerAttributes。
VersionString2020-04-01API版本信息,当前版本为:2020-04-01。
LoadBalancerIdStringclb-bp1b6c719dfa08ex****负载均衡实例ID。您可以调用DescribeLoadBalancers接口获取负载均衡实例ID。

返回参数

字段类型示例值
描述
RequestIdString202108161106382514606306AF947C****请求ID。
AccountIdString210012****负载均衡实例所属的账号ID。

ExclusiveClusterId

String

ec-bp1o94dp5i6ea****

独占集群的ID。

非独占集群类型的CLB实例该参数返回为空。

LoadBalancerIdStringclb-bp1b6c719dfa08ex****负载均衡实例ID。
LoadBalancerNameStringclb-test1负载均衡实例的名称。

Status

String

Active

负载均衡实例状态。

  • Inactive:已停止。
  • Active:运行中。
  • Creating:创建中。
  • Provisioning:创建中。
  • Configuring:配置中。
  • Deleting:删除中。
  • CreateFailed:创建失败。
DescriptionString测试实例负载均衡实例的描述。
CreateTimeString2021-08-11T16:37:37Z负载均衡实例的创建时间。
UpdateTimeString2021-08-11T16:37:37Z负载均衡实例的最近操作时间。

Type

String

private

负载均衡实例的类型。

  • public:表示创建一个公网负载均衡实例,系统会分配一个公网IP地址和一个私网IP地址,公网IP地址用于转发公网请求,私网IP地址用于转发私网请求。
  • private:表示创建一个私网负载均衡实例,系统会分配一个私网IP地址,仅用于转发私网请求。
MasterZoneIdStringcn-shanghai-a负载均衡实例的主可用区ID。

SlaveZoneId

String

cn-shanghai-b

负载均衡实例的备可用区ID。
负载均衡实例为单可用区实例时,该参数返回为空。

VpcIdStringvpc-bp1aevy8sofi8mh1****负载均衡实例所属的VPC ID。
SubnetIdStringsubnet-bp12mw1f8k3jgy****负载均衡实例所属的子网ID。

ModificationProtectionStatus

String

ConsoleProtection

负载均衡修改保护状态。

  • NonProtection:不开启修改保护功能,配置后会清空已配置的ModificationProtectionReason
  • ConsoleProtection:开启控制台修改保护功能,表示禁止通过控制台修改实例或删除实例,但允许通过API接口修改或删除。

ModificationProtectionReason

String

托管实例

设置修改保护状态的原因。

说明

仅在ModificationProtectionStatusConsoleProtection时有效。

AddressIpVersion

String

ipv4

负载均衡实例的IP地址类型。

  • ipv4:表示该负载均衡为IPv4类型,仅支持转发IPv4请求。
  • DualStack:表示该负载均衡为双栈类型,支持转发IPv4和IPv6请求。
EipIDStringeip-2fe698wsnjoxruvtryndp****公网IP的ID。
Ipv6EipIdStringeip-2zaiwb7ujxscd****IPv6公网带宽的ID。
EniAddressNumInteger2负载均衡实例的私网IPv4地址数量。
EniAddressesArray of String["172.XX.XX.2", "172.XX.XX.3"]负载均衡实例的私网IPv4地址信息。具体请参见下表“ EniAddresses”。
EniAddressString172.XX.XX.33负载均衡实例的私网IPv4地址。
EniIpv6AddressString2408:4005:XX:XX:200负载均衡实例的私网IPv6地址。
EniIDStringeni-2fe6rabqt8gxruv8u8c9f****负载均衡实例占用的网卡ID。
EipAddressString10.XX.XX.27负载均衡实例的公网IP地址。

BusinessStatus

String

FinancialLocked

负载均衡实例是否被锁定。

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

说明

该参数返回为空时,表示实例未被锁定。

LockReason

String

Financial

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

  • Financial: 因欠费被锁定。

说明

参数BusinessStatus取值为“Normal”或空值时,该参数返回为空。

LogTopicIdString74936ae4-bbd6-41de-a0d2-ed156203****日志主题的ID。

OverdueTime

String

2021-08-11T16:37:37Z

负载均衡实例的冻结时间。

说明

参数BusinessStatus取值为“Normal”或空值时,该参数返回为空。

DeletedTimeString2021-08-11T16:37:37Z负载均衡实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。

ExpiredTime

String

2021-08-11T23:59:59Z

负载均衡实例到期时间。

说明

仅在参数LoadBalancerBillingType配置为1时,返回该参数。

LoadBalancerSpecStringsmall_1负载均衡实例的规格。

LoadBalancerBillingType

Integer

2

负载均衡实例计费类型。

  • 1:包年包月
  • 2:按量计费-按规格计费
  • 3:按量计费-按使用量计费

Enabled

Boolean

true

负载均衡实例的启用状态。

  • true:表示启用。
  • false:表示禁用。

说明

当负载均衡实例处于欠费关停或到期关停状态时,该参数值为“false”,其他情况下均为“true”。

ProjectNameStringdefault负载均衡实例所属项目的名称。

ServiceManaged

Boolean

false

CLB实例是否为托管资源。

  • true:托管资源。表示创建CLB以外的其他云资源时系统同步创建的CLB资源。
  • false:非托管资源。表示在CLB侧手动创建的CLB资源。
EipStruct-负载均衡实例的公网IP的信息。具体请参见下表“ Eip ”。
Ipv6AddressBandwidthStruct-负载均衡实例的IPv6公网带宽信息。具体请参见下表“ Ipv6AddressBandwidth ”。
ServerGroupsArray of Struct-负载均衡实例中后端服务器组的信息。具体请参见下表“ ServerGroup ”。
ListenersArray of Struct-负载均衡实例中监听器的信息。具体请参见下表“ Listener ”。
AccessLogStruct-负载均衡实例中访问日志的信息。具体请参见下表“ AccessLog ”。
TagsArray of Struct-负载均衡实例的标签信息。具体请参见下表“Tags”。
AllowedPortsArray of String["23/23", "80-90"]负载均衡实例允许监听器使用的监听端口范围。

Eip

字段类型示例值
描述

ISP

String

BGP

负载均衡实例上的公网IP线路类型。

  • BGP:BGP (多线)。
  • ChinaMobile:中国移动静态单线。
  • ChinaTelecom:中国电信静态单线。
  • ChinaUnicom:中国联通静态单线。
  • SingleLine_BGP:BGP单线。
  • Static_BGP:静态BGP。

说明

除BGP(多线)外,其他线路类型均在邀测中,如需使用,请提交工单或联系客户经理申请。

EipBillingType

Integer

2

公网IP的计费方式。

  • 1:包年包月计费
  • 2:按量计费-按带宽上限计费(默认值)
  • 3:按量计费-按实际流量计费
BandwidthInteger10公网IP的带宽峰值,单位为Mbps。
EipAddressString10.XX.XX.27负载均衡实例的公网IP地址。
BandwidthPackageIdStringbwp-2zeo05qre24nhrqpy****公网IP关联的共享带宽包实例ID。

SecurityProtectionTypes

Array of String

["AntiDDoS_Enhanced"]

公网IP的安全防护类型。

  • AntiDDoS_Enhanced:表示公网IP为增强防护类型,该公网IP可以加入到DDoS原生防护(企业版)实例。
  • 空值:表示公网IP为基础防护类型。

Ipv6AddressBandwidth

名称类型示例值描述
BandwidthInteger10IPv6公网带宽的带宽峰值,单位为Mbps。

NetworkType

String

public

负载均衡实例IPv6地址的网络类型。

  • public:表示该IPv6地址已开通公网带宽,可以转发IPv6公网流量。

BillingType

Integer

2

IPv6公网带宽的计费类型。

  • 2:按量计费-按带宽上限计费。
  • 3:按量计费-按实际流量计费。

ISP

String

BGP

IPv6公网带宽的线路类型。

  • BGP:BGP(多线)。
BandwidthPackageIdStringbwp-2zeo05qre24nhrqpy****IPv6公网带宽关联的共享带宽包ID。

ServerGroup

字段类型示例值
描述
ServerGroupIdStringrsp-1g0ogy36a8t8g8ibuxwy5****负载均衡实例中后端服务器组的ID。
ServerGroupNameStringservergroup-1负载均衡实例中后端服务器组的名称。

Listener

字段类型示例值
描述
ListenerIdStringlsn-2fea4ayvu2g3k5oxruuze****负载均衡实例中监听器的ID。
ListenerNameStringlistener-1负载均衡实例中监听器的名称。

AccessLog

字段类型示例值
描述

Enabled

Boolean

true

是否开启访问日志(七层)功能。

  • true:已开启。
  • false:未开启。
BucketNameStringclb-tos存储七层访问日志的对象存储桶的名称。

Tags

名称类型示例值描述
KeyStringk1标签的标签键。
ValueStringv1标签的标签值。

EniAddresses

名称类型示例值描述
EniAddressString172.XX.XX.33负载均衡实例的辅助私网IPv4地址。
EipIdStringeip-3ciyamhu46c6rrswwusg****辅助私网IPv4地址绑定的公网IP的ID。
EipAddressString10.XX.XX.27辅助私网IPv4地址绑定的公网IP地址。

请求示例

GET /?Action=DescribeLoadBalancerAttributes&LoadBalancerId=clb-bp1b6c719dfa08ex****&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-shanghai
Service: clb

返回示例

{
    "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",
        "Status": "Active",
        "Description": "测试实例",
        "CreateTime": "2021-08-11T18:01:42Z",
        "UpdateTime": "2021-08-11T18:18:13Z",
        "Type": "public",
        "MasterZoneId": "cn-shanghai-a",
        "SlaveZoneId": "cn-shanghai-b",
        "VpcId": "vpc-bp1aevy8sofi8mh1****",
        "SubnetId": "subnet-bp12mw1f8k3jgy****",
        "ModificationProtectionStatus": "",
        "ModificationProtectionReason": "",
        "AddressIpVersion": "ipv4",
        "EipID": "eip-2fe698wsnjoxruvtryndp****",
        "Ipv6EipId": "",
        "EipAddress": "10.XX.XX.27",
        "EniIpv6Address": "",
        "EniID": "eni-2fe6rabqt8gxruv8u8c9f****",
        "EniAddress": "172.XX.XX.33",
        "BusinessStatus": "",
        "LockReason": "",
        "LogTopicId": "",
        "OverdueTime": "",
        "DeletedTime": "",
        "LoadBalancerSpec": "small_1",
        "LoadBalancerBillingType": 2,
        "Enabled": true,
        "ProjectName": "default",
        "ServiceManaged": false,
        "AccessLog": {
            "Enabled": true,
            "BucketName": "clb-tos"
        },
        "Eip": {
            "ISP": "BGP",
            "Bandwidth": 1,
            "EipBillingType": 0,
            "EipAddress": "10.XX.XX.27",
            "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",
            "SecurityProtectionTypes": [ 
                "AntiDDoS_Enhanced" 
            ]
        },
        "Ipv6AddressBandwidth": { 
            "ISP": "BGP", 
            "Bandwidth": 10, 
            "EipBillingType": 2, 
            "NetworkType": "public",
            "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****" 
        },
        "ServerGroups": [
            {
                "ServerGroupId": "rsp-1g0ogy36a8t8g8ibuxwy5****",
                "ServerGroupName": "servergroup-1"
            }
        ],
        "Listeners": [
            {
                "ListenerId": "lsn-2fea4ayvu2g3k5oxruuze****",
                "ListenerName": "listener-1"
            }
        ],
        "Tags": [ 
            { 
                "Key": "k1", 
                "Value": "v1" 
            }, 
            { 
                "Key": "volc:clb:k1", 
                "Value": "" 
            } 
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如XXX

说明

其中,XXX表示缺少的参数名称。

404InvalidLoadBalancer.NotFoundThe specified LoadBalancer does not exist.指定的负载均衡不存在。