详情页标题前

阿里云负载均衡GetLoadBalancerAttribute – 查询负载均衡实例的详细信息-云淘科技

详情页1

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

调试

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

调试阿里云负载均衡GetLoadBalancerAttribute - 查询负载均衡实例的详细信息-云淘科技调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
LoadBalancerId string

网络型负载均衡实例ID

nlb-83ckzc8d4xlp8o****
DryRun boolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会查询实例的配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
false
ClientToken string

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明
若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。

123e4567-e89b-12d3-a456-426655440000
RegionIdstring

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

cn-hangzhou

返回参数

名称 类型 描述 示例值
object

response

RequestId string

请求ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionId string

NLB实例所在的地域ID。

cn-hangzhou
LoadBalancerId string

NLB实例ID。

nlb-83ckzc8d4xlp8o****
LoadBalancerName string

NLB实例名称。

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

NLB1
LoadBalancerType string

负载均衡类型。仅取值:network,表示网络型负载均衡。

network
AddressType string

NLB实例的IPv4网络地址类型。取值:

  • Internet:公网。负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
  • Intranet:私网。负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
Internet
AddressIpVersion string

协议版本。取值:

  • ipv4:IPv4类型。
  • DualStack:双栈类型。
ipv4
Ipv6AddressType string

NLB实例的IPv6地址类型。取值:

  • Internet:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
  • Intranet:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
Internet
LoadBalancerStatus string

NLB实例状态。取值:

  • Inactive:已停止,表示实例监听不会再转发流量。
  • Active:运行中。
  • Provisioning:创建中。
  • Configuring:变配中。
  • CreateFailed:创建失败,此时不会产生费用,实例只能被删除。
Active
LoadBalancerBusinessStatus string

NLB的业务状态。取值:

  • Abnormal:异常状态。
  • Normal:正常状态。
Normal
OperationLocks object []

NLB实例处于锁定状态列表。在LoadBalancerBussinessStatusAbnormal(异常状态)时才返回当前参数。

LockType string

锁定的类型。取值 :

  • SecurityLocked:安全锁定。
  • RelatedResourceLocked:关联锁定。
  • FinancialLocked:欠费锁定。
  • ResidualLocked:残留锁定。
SecurityLocked
LockReason string

锁定的原因。

业务异常。
VpcId string

NLB实例的专有网络ID。

vpc-bp1b49rqrybk45nio****
CreateTime string

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

2022-07-02T02:49:05Z
ResourceGroupId string

资源组ID。

rg-atstuj3rtop****
DNSName string

DNS域名。

nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
ZoneMappings object []

可用区及交换机映射列表,至少需要添加2个可用区,最多支持添加10个可用区。

VSwitchId string

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

vsw-bp1rmcrwg3erh1fh8****
ZoneId string

可用区ID,您可以通过调用DescribeZones接口获取。

cn-hangzhou-a
LoadBalancerAddresses object []

网络型负载均衡实例地址信息。

EniId string

ENI的ID。

eni-bp12f1xhs5yal61a****
PrivateIPv4Address string

NLB实例私网IPv4地址。

192.168.3.32
AllocationId string

弹性公网IP实例ID。

eip-bp1aedxso6u80u0qf****
PublicIPv4Address string

NLB实例公网IPv4地址。

120.XX.XX.69
Ipv6Address string

NLB实例IPv6地址。

2001:db8:1:1:1:1:1:1
PrivateIPv4HcStatus string

NLB实例私网IPv4地址的探测状态。取值:

  • Healthy:健康。
  • Unhealthy:异常。

说明
只有可用区状态(Status)为运行中(Active)时才返回该参数。

Healthy
PrivateIPv6HcStatusstring

NLB实例IPv6地址的探测状态。取值:

  • Healthy:健康。
  • Unhealthy:异常。

说明
只有可用区状态(Status)为运行中(Active)时才返回该参数。

Healthy
Statusstring

可用区状态。取值:

  • Active:启动。
  • Stopped:停止。该状态仅支持通过CADT容灾管理服务调用实现。
  • Shifted:DNS摘除。
  • Starting:启动中。该状态仅支持通过CADT容灾管理服务调用实现。
  • Stopping:停止中。该状态仅支持通过CADT容灾管理服务调用实现。
Active
BandwidthPackageId string

公网类型实例关联的共享带宽包ID。

cbwp-bp1vevu8h3ieh****
SecurityGroupIds array

NLB实例绑定的安全组ID。

string

NLB实例绑定的安全组ID。

sg-bp10uag3q0jkxu72****
CrossZoneEnabled boolean

NLB实例是否开启跨可用区。取值:

  • true:开启。
  • false:关闭。
true
LoadBalancerBillingConfig object

负载均衡实例计费配置。

PayType string

NLB实例的计费类型。
仅取值PostPay:表示按量计费。

PostPay
Cps integer

NLB实例每秒新建连接限速值。取值范围:0~1000000

0表示不限速。

100
DeletionProtectionConfig object

删除保护配置。

Enabled boolean

删除保护状态,取值:

  • true:开启状态。
  • false:关闭状态。
true
Reason string

更改删除保护状态的原因。长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

实例运行中
EnabledTime string

删除保护开启时间,使用格林威治时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-11-02T02:49:05Z
ModificationProtectionConfig object

修改保护配置。

Status string

网络型负载均衡修改保护状态。取值:

  • NonProtection:不保护,表示不允许传入修改保护配置的Reason字段。如果配置了Reason,则清空其配置信息。
  • ConsoleProtection:控制台修改保护,此时允许传入修改保护配置的Reason字段。

说明
当取值为ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用API修改实例配置。

ConsoleProtection
Reasonstring

输入开启修改保护的原因。长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

仅在修改保护配置的StatusConsoleProtection有效且合法。

业务保障期
EnabledTime string

修改保护时间,使用格林威治时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-12-02T02:49:05Z
Tags object []

标签列表。

TagKey string

实例的标签键。

KeyTest
TagValue string

实例的标签值。

ValueTest

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId": "cn-hangzhou",
  "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
  "LoadBalancerName": "NLB1",
  "LoadBalancerType": "network",
  "AddressType": "Internet",
  "AddressIpVersion": "ipv4",
  "Ipv6AddressType": "Internet",
  "LoadBalancerStatus": "Active",
  "LoadBalancerBusinessStatus": "Normal",
  "OperationLocks": [
    {
      "LockType": "SecurityLocked",
      "LockReason": "业务异常。"
    }
  ],
  "VpcId": "vpc-bp1b49rqrybk45nio****",
  "CreateTime": "2022-07-02T02:49:05Z",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "DNSName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
  "ZoneMappings": [
    {
      "VSwitchId": "vsw-bp1rmcrwg3erh1fh8****",
      "ZoneId": "cn-hangzhou-a",
      "LoadBalancerAddresses": [
        {
          "EniId": "eni-bp12f1xhs5yal61a****",
          "PrivateIPv4Address": "192.168.3.32",
          "AllocationId": "eip-bp1aedxso6u80u0qf****",
          "PublicIPv4Address": "120.XX.XX.69",
          "Ipv6Address": "2001:db8:1:1:1:1:1:1",
          "PrivateIPv4HcStatus": "Healthy",
          "PrivateIPv6HcStatus": "Healthy"
        }
      ],
      "Status": "Active"
    }
  ],
  "BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
  "SecurityGroupIds": [
    "sg-bp10uag3q0jkxu72****"
  ],
  "CrossZoneEnabled": true,
  "LoadBalancerBillingConfig": {
    "PayType": "PostPay"
  },
  "Cps": 100,
  "DeletionProtectionConfig": {
    "Enabled": true,
    "Reason": "实例运行中",
    "EnabledTime": "2022-11-02T02:49:05Z"
  },
  "ModificationProtectionConfig": {
    "Status": "ConsoleProtection",
    "Reason": "业务保障期",
    "EnabledTime": "2022-12-02T02:49:05Z"
  },
  "Tags": [
    {
      "TagKey": "KeyTest",
      "TagValue": "ValueTest"
    }
  ]
}

错误码

HTTP status code 错误码 错误信息 描述
400 DuplicatedParam.%s The param of %s is duplicated. 参数%s重复了
403 Forbidden.NoPermission Authentication is failed for NoPermission. 因为账号没有权限,所以鉴权失败。
404 ResourceNotFound.loadBalancer The specified resource of loadbalancer is not found. 找不到指定的负载均衡器资源,请检查输入参数。

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

变更历史

变更时间 变更内容概要 操作
2023-09-05 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
    删除错误码:400
2023-08-22 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
    新增错误码:404
2023-06-07 OpenAPI 返回结构发生变更 看变更集
变更项 变更内容
出参 OpenAPI 返回结构发生变更
2023-04-04 OpenAPI 返回结构发生变更 看变更集
变更项 变更内容
出参 OpenAPI 返回结构发生变更

内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家

阿里云企业补贴进行中: 马上申请

腾讯云限时活动1折起,即将结束: 马上收藏

同尘科技为腾讯云授权服务中心。

购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠

转转请注明出处:https://www.yunxiaoer.com/168351.html

(0)
上一篇 2023年12月10日
下一篇 2023年12月10日
详情页2

相关推荐

  • 阿里云RDS数据库服务关联角色管理-云淘科技

    如果首次创建RDS实例,需要授权服务关联角色(AliyunServiceRoleForRdsPgsqlOnEcs),允许RDS服务通过该角色完成弹性网卡的挂载动作,进而打通网络链路。本文介绍服务关联角色的相关配置。 前提条件 使用Terraform,您需要一个阿里云账号和访问密钥(AccessKey),详细操作请参见创建AccessKey。 已经安装并配置了…

    阿里云数据库 2023年12月10日
  • 阿里云对象存储OSSJava数据校验-云淘科技

    OSS提供基于MD5和CRC64的数据校验,确保上传、下载和拷贝文件(Object)过程中的数据完整性。 注意事项 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见访问域名和数据中心。 本文以从环境变量读取访问凭证…

    阿里云对象存储 2023年12月10日
  • 阿里云RDS数据库查看性能事件-云淘科技

    RDS提供查看性能事件的功能,可以查看数据库实例异常事件、优化事件和弹性伸缩事件的明细以及统计信息,包括计划执行、正在执行和已执行完成的事件。 查看事件和建议 访问RDS实例列表,在上方选择地域,然后单击目标实例ID。 在左侧导航栏单击监控与报警。 在性能事件页面,单击事件和建议页签,查看选定时间范围内各类事件的统计数据。 说明 选择时间范围时,查询结束时间…

    2023年12月9日
  • 阿里云日志服务SLSDeleteProjectPolicy-云淘科技

    调用DeleteProjectPolicy接口删除Project的授权策略(Policy)。 接口说明 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。 已创建并获取AccessKey。更多信息,请参见访问密钥。 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用R…

    阿里云日志服务SLS 2023年12月10日
  • 信息流广告,信息流部分建议宽度830px,只针对默认列表样式,顺序随机
  • 阿里云RDS数据库创建账号-云淘科技

    本文介绍如何为RDS PostgreSQL实例创建账号。 账号类型 RDS PostgreSQL实例支持两种数据库账号:高权限账号和普通账号。详细说明如下。 账号类型 说明 高权限账号 只能通过控制台或API创建和管理。 可以创建多个高权限账号,管理所有普通账号和数据库。 开放了更多权限,可满足个性化和精细化的权限管理需求,例如可按用户分配不同表的查询权限。…

    阿里云数据库 2023年12月9日

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。