查询指定负载均衡实例的详细信息。
接口说明
说明
如果后端设置在虚拟服务器组下面,请调用DescribeVServerGroupAttribute查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
slb:DescribeLoadBalancerAttribute | Read |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 |
传统型负载均衡实例的地域ID。 您可以通过调用DescribeRegions接口查询地域ID。 |
cn-hangzhou |
LoadBalancerId | string | 是 |
传统型负载均衡实例ID。 |
lb-bp1b6c719dfa08ex**** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
VpcId | string |
传统型负载均衡私网实例的专有网络ID。 |
vpc-25dvzy9f8**** |
Tags | object [] |
标签列表。 |
|
TagKey | string |
实例的标签键。N的取值范围:1~20。一旦输入该值,则不允许为空字符串。 最多支持64个字符,不能以 |
test |
TagValue | string |
实例的标签值。N的取值范围:1~20。一旦输入该值,可以为空字符串。 最多支持128个字符,不能以 |
value |
CreateTimeStamp | long |
传统型负载均衡实例创建时间戳。 |
1504147745000 |
CreateTime | string |
传统型负载均衡实例的创建时间。格式为: |
2017-08-31T02:49:05Z |
LoadBalancerId | string |
传统型负载均衡实例的ID。 |
lb-bp1b6c719dfa08ex**** |
PayType | string |
传统型负载均衡实例付费类型。取值:
|
PayOnDemand |
AddressType | string |
传统型负载均衡实例的地址类型。 |
internet |
NetworkType | string |
传统型负载均衡实例的网络类型。 |
vpc |
AddressIPVersion | string |
IP版本。取值:ipv4或ipv6。 |
ipv4 |
RenewalCycUnit | string |
自动续费周期,取值:Year或Month(默认值)。 说明 | Month |
RequestId | string | 请求ID。 |
365F4154-92F6-4AE4-92F8-7FF34B540710 |
Bandwidth | integer |
按带宽计费的公网型实例的带宽峰值。 |
5 |
LoadBalancerName | string |
传统型负载均衡实例的名称。 |
lb-instance-test |
Address | string |
传统型负载均衡实例的服务地址。 |
42.XX.XX.6 |
SlaveZoneId | string |
传统型负载均衡实例的备可用区ID。 |
cn-hangzhou-d |
EndTimeStamp | long |
传统型负载均衡实例结束时间戳。 |
3249380160000 |
MasterZoneId | string |
传统型负载均衡实例的主可用区ID。 |
cn-hangzhou-b |
LoadBalancerSpec | string |
传统型负载均衡实例的性能规格。 |
slb.s1.small |
AutoReleaseTime | long |
释放时间的时间戳。 |
1513947075000 |
ModificationProtectionReason | string |
设置修改保护状态的原因,长度为1~80个字符,必须以字母或中文开头,支持数字、半角句号(.)、下划线(_)和短划线(-)。 说明 | 实例业务保障期 |
RegionId | string | 传统型负载均衡实例所在地域ID。 |
cn-hangzhou |
ModificationProtectionStatus | string |
传统型负载均衡修改保护状态:
说明 | ConsoleProtection |
EndTime | string | 传统型负载均衡实例结束时间。 |
2022-09-08T16:00:00Z |
VSwitchId | string |
私网实例的交换机ID。 |
vsw-255ecrwq5**** |
LoadBalancerStatus | string |
传统型负载均衡实例状态:
|
active |
ResourceGroupId | string |
企业资源组ID。 |
rg-atstuj3rtop**** |
InternetChargeType | string |
公网类型实例付费方式。取值:
|
paybytraffic |
DeleteProtection | string |
是否开启实例删除保护。 取值:on或off。 |
off |
RegionIdAlias | string |
传统型负载均衡实例所属的地域别名。 |
hangzhou |
RenewalStatus | string |
续费状态,取值:
说明 | AutoRenewal |
RenewalDuration | integer | 自动续费时长,仅在RenewalStatus为AutoRenewal时有效。
说明 | 1 |
ListenerPorts | array | 传统型负载均衡实例前端使用的端口。 |
|
integer |
传统型负载均衡实例前端使用的端口。 |
80 | |
ListenerPortsAndProtocal | object [] |
监听端口或协议。 |
|
ListenerProtocal | string |
传统型负载均衡实例前端使用的协议。 |
http |
ListenerPort | integer |
实例前端使用的端口。 |
443 |
ListenerPortsAndProtocol | object [] |
实例前端使用的端口和协议。 |
|
ListenerPort | integer |
实例前端使用的端口。 |
80 |
ListenerProtocol | string |
实例前端使用的协议。 |
https |
ListenerForward | string |
是否启用监听转发。 |
on |
Description | string |
监听端口和协议描述。 |
监听描述 |
ForwardPort | integer |
转发到的目的监听端口,必须是已经存在的HTTPS监听端口。 |
443 |
BackendServers | object [] |
实例的后端服务器列表。 |
|
Type | string |
后端服务器类型。 |
ecs |
Weight | integer |
后端服务器的权重。 |
90 |
Description | string |
后端服务器描述。 说明 | 用来接收转发请求的后端服务器 |
ServerIp | string | ENI或ECI的实例ID。 |
192.XX.XX.11 |
ServerId | string |
后端服务器实例ID。 |
i-2zej4lxhjoq1icu***** |
InstanceChargeType | string |
实例计费方式。取值:
|
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | LocationServiceTimeout | Location service connection timeout. Please try again later. | Location服务连接超时,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/170303.html