首页 负载均衡 传统型负载均衡CLB 开发参考 API参考 API目录 实例 DescribeLoadBalancerAttribute - 查询指定负载均衡实例的详细信息

DescribeLoadBalancerAttribute - 查询指定负载均衡实例的详细信息

更新时间: 2023-11-28 10:06:16

查询指定负载均衡实例的详细信息。

接口说明

说明 如果后端设置在虚拟服务器组下面,请调用DescribeVServerGroupAttribute查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:DescribeLoadBalancerAttributeRead
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag

请求参数

名称类型必填描述示例值
RegionIdstring

传统型负载均衡实例的地域ID。

您可以通过调用DescribeRegions接口查询地域ID。

cn-hangzhou
LoadBalancerIdstring

传统型负载均衡实例ID。

lb-bp1b6c719dfa08ex****

返回参数

名称类型描述示例值
object
VpcIdstring

传统型负载均衡私网实例的专有网络ID。

vpc-25dvzy9f8****
Tagsobject []

标签列表。

TagKeystring

实例的标签键。N的取值范围:1~20。一旦输入该值,则不允许为空字符串。

最多支持64个字符,不能以aliyunacs:开头,不能包含http://或者https://

test
TagValuestring

实例的标签值。N的取值范围:1~20。一旦输入该值,可以为空字符串。

最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

value
CreateTimeStamplong

传统型负载均衡实例创建时间戳。

1504147745000
CreateTimestring

传统型负载均衡实例的创建时间。格式为:YYYY-MM-DDThh:mm:ssZ

2017-08-31T02:49:05Z
LoadBalancerIdstring

传统型负载均衡实例的ID。

lb-bp1b6c719dfa08ex****
PayTypestring

传统型负载均衡实例付费类型。取值:

  • PrePay:包年包月。

  • PayOnDemand(默认值):按量付费。

PayOnDemand
AddressTypestring

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

internet
NetworkTypestring

传统型负载均衡实例的网络类型。

vpc
AddressIPVersionstring

IP版本。取值:ipv4ipv6

ipv4
RenewalCycUnitstring

自动续费周期,取值:YearMonth(默认值)。

说明 该参数仅适用于中国站包年包月实例,即PayType的参数值为PrePayRenewalStatusAutoRenewal时有效。
Month
RequestIdstring

请求ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
Bandwidthinteger

按带宽计费的公网型实例的带宽峰值。

5
LoadBalancerNamestring

传统型负载均衡实例的名称。

lb-instance-test
Addressstring

传统型负载均衡实例的服务地址。

42.XX.XX.6
SlaveZoneIdstring

传统型负载均衡实例的备可用区ID。

cn-hangzhou-d
EndTimeStamplong

传统型负载均衡实例结束时间戳。

3249380160000
MasterZoneIdstring

传统型负载均衡实例的主可用区ID。

cn-hangzhou-b
LoadBalancerSpecstring

传统型负载均衡实例的性能规格。

slb.s1.small
AutoReleaseTimelong

释放时间的时间戳。

1513947075000
ModificationProtectionReasonstring

设置修改保护状态的原因,长度为1~80个字符,必须以字母或中文开头,支持数字、半角句号(.)、下划线(_)和短划线(-)。

说明 仅在ModificationProtectionStatusConsoleProtection时有效。
实例业务保障期
RegionIdstring

传统型负载均衡实例所在地域ID。

cn-hangzhou
ModificationProtectionStatusstring

传统型负载均衡修改保护状态:

  • NonProtection:不限制修改保护,设置后会清空之前设置的ModificationProtectionReason
  • ConsoleProtection:实例控制台修改保护状态。
说明 当取值为ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用API修改实例配置。
ConsoleProtection
EndTimestring

传统型负载均衡实例结束时间。

2022-09-08T16:00:00Z
VSwitchIdstring

私网实例的交换机ID。

vsw-255ecrwq5****
LoadBalancerStatusstring

传统型负载均衡实例状态:

  • inactive:实例已停止,此状态的实例监听不会再转发流量。

  • active:实例运行中,实例创建后,默认状态为active

  • locked:实例已锁定,实例已经欠费或被阿里云锁定。

active
ResourceGroupIdstring

企业资源组ID。

rg-atstuj3rtop****
InternetChargeTypestring

公网类型实例付费方式。取值:

  • paybytraffic:按使用流量计费。
  • paybybandwidth:按固定带宽计费。
paybytraffic
DeleteProtectionstring

是否开启实例删除保护。

取值:onoff

off
RegionIdAliasstring

传统型负载均衡实例所属的地域别名。

hangzhou
RenewalStatusstring

续费状态,取值:

  • AutoRenewal:自动续费。
  • Normal:非自动续费,您需要自行续费负载均衡实例。
  • NotRenewal:不再续费。返回该值后,系统不再发送到期提醒,只在到期前第三天发送不续费提醒。
说明 该参数仅适用于中国站包年包月实例,即PayType的参数值为PrePay时有效。
AutoRenewal
RenewalDurationinteger

自动续费时长,仅在RenewalStatusAutoRenewal时有效。

  • PeriodUnitYear时,取值:123
  • PeriodUnitMonth时,取值:1236
说明 该参数仅适用于中国站包年包月实例,即PayType的参数值为PrePay时有效。
1
ListenerPortsarray

传统型负载均衡实例前端使用的端口。

integer

传统型负载均衡实例前端使用的端口。

80
ListenerPortsAndProtocalobject []

监听端口或协议。

ListenerProtocalstring

传统型负载均衡实例前端使用的协议。

http
ListenerPortinteger

实例前端使用的端口。

443
ListenerPortsAndProtocolobject []

实例前端使用的端口和协议。

ListenerPortinteger

实例前端使用的端口。

80
ListenerProtocolstring

实例前端使用的协议。

https
ListenerForwardstring

是否启用监听转发。

on
Descriptionstring

监听端口和协议描述。

监听描述
ForwardPortinteger

转发到的目的监听端口,必须是已经存在的HTTPS监听端口。

443
BackendServersobject []

实例的后端服务器列表。

Typestring

后端服务器类型。 ecs:ECS实例(默认)。 eni:弹性网卡实例。 eci:弹性容器实例。

ecs
Weightinteger

后端服务器的权重。

90
Descriptionstring

后端服务器描述。

说明 若用户未设置Description,则该参数不返回。
用来接收转发请求的后端服务器
ServerIpstring

ENI或ECI的实例ID。

192.XX.XX.11
ServerIdstring

后端服务器实例ID。

i-2zej4lxhjoq1icu*****
InstanceChargeTypestring

实例计费方式。取值:

  • PayBySpec:按规格计费。
  • PayByCLCU:按使用量计费。
PayBySpec

示例

正常返回示例

JSON格式

{
  "VpcId": "vpc-25dvzy9f8****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "value"
      }
    ]
  },
  "CreateTimeStamp": 1504147745000,
  "CreateTime": "2017-08-31T02:49:05Z",
  "LoadBalancerId": "lb-bp1b6c719dfa08ex****",
  "PayType": "PayOnDemand",
  "AddressType": "internet",
  "NetworkType": "vpc",
  "AddressIPVersion": "ipv4",
  "RenewalCycUnit": "Month",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Bandwidth": 5,
  "LoadBalancerName": "lb-instance-test",
  "Address": "42.XX.XX.6",
  "SlaveZoneId": "cn-hangzhou-d",
  "EndTimeStamp": 3249380160000,
  "MasterZoneId": "cn-hangzhou-b",
  "LoadBalancerSpec": "slb.s1.small",
  "AutoReleaseTime": 1513947075000,
  "ModificationProtectionReason": "实例业务保障期",
  "RegionId": "cn-hangzhou",
  "ModificationProtectionStatus": "ConsoleProtection",
  "EndTime": "2022-09-08T16:00:00Z",
  "VSwitchId": "vsw-255ecrwq5****",
  "LoadBalancerStatus": "active",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "InternetChargeType": "paybytraffic",
  "DeleteProtection": "off",
  "RegionIdAlias": "hangzhou",
  "RenewalStatus": "AutoRenewal",
  "RenewalDuration": 1,
  "ListenerPorts": {
    "ListenerPort": [
      80
    ]
  },
  "ListenerPortsAndProtocal": {
    "ListenerPortAndProtocal": [
      {
        "ListenerProtocal": "http",
        "ListenerPort": 443
      }
    ]
  },
  "ListenerPortsAndProtocol": {
    "ListenerPortAndProtocol": [
      {
        "ListenerPort": 80,
        "ListenerProtocol": "https",
        "ListenerForward": "on",
        "Description": "监听描述",
        "ForwardPort": 443
      }
    ]
  },
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 90,
        "Description": "用来接收转发请求的后端服务器",
        "ServerIp": "192.XX.XX.11",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  },
  "InstanceChargeType": "PayBySpec"
}

错误码

HTTP status code错误码错误信息描述
400LocationServiceTimeoutLocation service connection timeout. Please try again later.Location服务连接超时,请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
阿里云首页 负载均衡 相关技术圈