全部产品
Search
文档中心

负载均衡:GetLoadBalancerAttribute - 查询负载均衡实例详细信息

更新时间:Dec 02, 2024

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

调试

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

授权信息

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

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

请求参数

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

网关型负载均衡实例的 ID

gwlb-9njtjmqt7zfcqm****

返回参数

名称类型描述示例值
object
AddressIpVersionstring

协议版本。取值:

  • Ipv4:Ipv4 类型
Ipv4
CreateTimestring

资源创建时间,使用格林威治时间,格式为yyyy-MM-ddTHH:mm:ssZ

2024-07-08T10:12:58Z
LoadBalancerBusinessStatusstring

网关型负载均衡的业务状态。取值:

  • Normal:正常状态。
  • FinancialLocked:欠费锁定状态。
Normal
LoadBalancerIdstring

网关型负载均衡实例的 ID。

gwlb-9njtjmqt7zfcqm****
LoadBalancerNamestring

网关型负载均衡实例名称。

长度为 2~128 个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

gwlb
LoadBalancerStatusstring

网关型负载均衡的实例状态。取值:

  • Active:运行中。
  • Inactive:已停止,表示实例监听不会再转发流量。
  • Provisioning:创建中。
  • Configuring:变配中。
Active
RequestIdstring

请求 ID。

B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF
ResourceGroupIdstring

资源组 ID。

rg-acfmx7pmxcy****
Tagsarray<object>

标签列表。

TagModelobject

标签对象。

Keystring

标签键。一旦传入该值,则不允许为空字符串。

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

testTagKey
Valuestring

标签值。最多支持 256 个字符,不能包含http://https://

testTagValue
VpcIdstring

专有网络 ID。

vpc-k1aajsbwbaq4todet****
ZoneMappingsarray<object>

可用区及交换机映射列表。至少需要添加一个可用区,最多支持添加 20 个可用区。若当前地域支持 2 个及以上的可用区,建议添加 2 个及以上可用区。

ZoneEniModelobject

可用区及交换机映射对象。

LoadBalancerAddressesarray<object>

网关型负载均衡实例地址列表。

EniModelsobject

网关型负载均衡实例地址对象。

EniIdstring

弹性网卡 ENI ID。

eni-bp1iahwz3rzgvltz****
PrivateIpv4Addressstring

IPv4 私网地址。

192.168.XX.XX
VSwitchIdstring

可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。

vsw-uf6v8l7d2f1k53xrl****
ZoneIdstring

可用区 ID。

cn-hangzhou-j

示例

正常返回示例

JSON格式

{
  "AddressIpVersion": "Ipv4",
  "CreateTime": "2024-07-08T10:12:58Z",
  "LoadBalancerBusinessStatus": "Normal",
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "LoadBalancerName": "gwlb",
  "LoadBalancerStatus": "Active",
  "RequestId": "B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF",
  "ResourceGroupId": "rg-acfmx7pmxcy****",
  "Tags": [
    {
      "Key": "testTagKey",
      "Value": "testTagValue"
    }
  ],
  "VpcId": "vpc-k1aajsbwbaq4todet****",
  "ZoneMappings": [
    {
      "LoadBalancerAddresses": [
        {
          "EniId": "eni-bp1iahwz3rzgvltz****",
          "PrivateIpv4Address": "192.168.XX.XX"
        }
      ],
      "VSwitchId": "vsw-uf6v8l7d2f1k53xrl****",
      "ZoneId": "cn-hangzhou-j"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.LoadBalancerThe specified resource of %s is not found.指定的负载均衡资源不存在
400MissingParam.LoadBalancerIdThe param of LoadBalancerId is missing.负载均衡ID参数缺失

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