1)接口功能介绍
查询负载均衡详情。
2)接口约束
无。
3)URI
GET /v1/describeLoadBalancerAttribute。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbId | 是 | String | 负载均衡器ID | 22 |
请求体body参数
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 负载均衡器id | 343 | |
regionCluster | 否 | String | 区域集群中文名 | 其它-广州7 | |
name | 是 | String | 负载均衡名称 | slb-084a | |
state | 是 | String | 负载均衡状态 . SLB_STATE_BROKEN: 故障 , SLB_STATE_RUNNING: 运行中 | SLB_STATE_RUNNING | |
eipIp | 否 | String | 弹性公网IP | 243 | |
vpcName | 是 | String | vpc名称 | vpc-jirqs | |
createTime | 是 | String | 创建时间 | 1618214099 | |
description | 是 | String | 描述 | sdk-test | |
internalIp | 否 | String | 内网IP,负载均衡类型为内网时,会返回此字段 | 198.19.0.2 | |
type | 是 | String | 负载均衡类型 EXTERNAL: 外网SLB, INTERNAL: 内网SLB | EXTERNAL | |
bandwidthInfo | 否 | Object | 带宽详情信息 | * | bandwidthInfo |
表 bandwidthInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bandwidthType | 是 | String | 带宽类型,分为独享带宽和共享带宽两类 。 EXCLUSIVE: 独享带宽, SHARED: 共享带宽 | EXCLUSIVE | |
bandwidthLimit | 是 | Integer | 带宽上限:Mbps | 10 |
6)请求示例
GET https://{host}/v1/describeLoadBalancerAttribute?slbId=3171
7)响应示例
{
"data": {
"id": "222",
"regionCluster": "其它-广州7",
"slbUid": "slb-c1pvpkl90v2ejn5eto0g",
"name": "slb-084a",
"state": "SLB_STATE_RUNNING",
"eipIp": "192.168.77.2",
"vpcName": "vpc-jirq",
"createTime": "1618214099",
"description": "sdk-test",
"bandwidthInfo": {
"bandwidthType": "EXCLUSIVE",
"bandwidthLimit": 1
},
"internalIp": "",
"type": "EXTERNAL"
},
"requestId": "414a7586-93a7-436f-a596-f726872fa901",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |