查询指定网络型负载均衡实例的详细信息。
调试
您可以在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字符。 说明 | 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 否 | 网络型负载均衡实例所在的地域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 |
AddressIpVersion | string |
协议版本。取值:
|
ipv4 |
Ipv6AddressType | string |
NLB实例的IPv6地址类型。取值:
|
Internet |
LoadBalancerStatus | string |
NLB实例状态。取值:
|
Active |
LoadBalancerBusinessStatus | string |
NLB的业务状态。取值:
|
Normal |
OperationLocks | object [] |
NLB实例处于锁定状态列表。在 |
|
LockType | string |
锁定的类型。取值 :
|
SecurityLocked |
LockReason | string |
锁定的原因。 |
业务异常。 |
VpcId | string |
NLB实例的专有网络ID。 |
vpc-bp1b49rqrybk45nio**** |
CreateTime | string |
资源创建时间,使用格林威治时间,格式为 |
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 |
PrivateIPv6HcStatus | string | NLB实例IPv6地址的探测状态。取值:
说明 | Healthy |
Status | string | 可用区状态。取值:
|
Active |
BandwidthPackageId | string |
公网类型实例关联的共享带宽包ID。 |
cbwp-bp1vevu8h3ieh**** |
SecurityGroupIds | array |
NLB实例绑定的安全组ID。 |
|
string |
NLB实例绑定的安全组ID。 |
sg-bp10uag3q0jkxu72**** | |
CrossZoneEnabled | boolean |
NLB实例是否开启跨可用区。取值:
|
true |
LoadBalancerBillingConfig | object |
负载均衡实例计费配置。 |
|
PayType | string |
NLB实例的计费类型。 |
PostPay |
Cps | integer |
NLB实例每秒新建连接限速值。取值范围:0~1000000。 0表示不限速。 |
100 |
DeletionProtectionConfig | object |
删除保护配置。 |
|
Enabled | boolean |
删除保护状态,取值:
|
true |
Reason | string |
更改删除保护状态的原因。长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 |
实例运行中 |
EnabledTime | string |
删除保护开启时间,使用格林威治时间,格式为 |
2022-11-02T02:49:05Z |
ModificationProtectionConfig | object |
修改保护配置。 |
|
Status | string |
网络型负载均衡修改保护状态。取值:
说明 | ConsoleProtection |
Reason | string | 输入开启修改保护的原因。长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 仅在修改保护配置的Status为ConsoleProtection有效且合法。 |
业务保障期 |
EnabledTime | string |
修改保护时间,使用格林威治时间,格式为 |
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 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
2023-06-07 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|
||||||||||
2023-04-04 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/168351.html