查询指定网络型负载均衡实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nlb:GetLoadBalancerAttribute | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| LoadBalancerId | string | 是 | 网络型负载均衡实例 ID。 | nlb-83ckzc8d4xlp8o**** |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| RegionId | string | 否 | 网络型负载均衡实例所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
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",
"Ipv4LocalAddresses": [
"192.168.36.16"
],
"Ipv6LocalAddresses": [
"2408:4005:357:ba00:64a2:221f:5685:8854"
]
}
],
"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重复了 |
| 400 | OperationFailed.GetXipFailed | Operation failed because GetXipFailed. | 操作失败，因为实例还在创建中。 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限，所以鉴权失败。 |
| 404 | ResourceNotFound.loadBalancer | The specified resource of loadbalancer is not found. | 找不到指定的负载均衡器资源，请检查输入参数。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-02-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2024-02-04 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2024-02-04 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-12-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-06-07 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-04-04 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
|