查看gwlb详情
更新时间 2025-10-29 14:21:00
最近更新时间: 2025-10-29 14:21:00
接口功能介绍
查看网关负载均衡详情
接口约束
无
URI
GET /v4/gwlb/show
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | bb9fdb42056f11eda1610242ac110002 | |
| projectID | 否 | String | 企业项目ID，默认"0" | 0 | |
| gwLbID | 是 | String | 网关负载均衡ID | gwlb-xxx |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Object | 接口业务数据 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| gwLbID | String | 网关负载均衡 ID | gwlb-xxx | |
| name | String | 名字 | test | |
| description | String | 描述 | desc | |
| vpcID | String | 虚拟私有云 ID | vpc-xxx | |
| subnetID | String | 子网 ID | subnet-xxx | |
| portID | String | 网卡 ID | port-xxx | |
| ipv6Enabled | Boolean | 是否开启 ipv6 | true | |
| privateIpAddress | String | 私有 IP 地址 | 192.2.2.2 | |
| ipv6Address | String | ipv6 地址 | 2001:db8:85a3::8a2e:370:7334 | |
| slaName | String | 规格 | elb.default | |
| deleteProtection | Boolean | 是否开启删除保护 | true | |
| createdAt | String | 创建时间 | 2023-12-18 10:00:00 | |
| updatedAt | String | 更新时间 | 2023-12-18 10:00:00 | |
| natType | Integer | nat类型 | 0 |
枚举参数
无
请求示例
请求url
GET /openapi/v4/gwlb/show?regionID=xxxx&gwLbID=xxxxx
请求头header
无
请求体body
无
响应示例
#### 成功响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"descritption": "成功",
"returnObj":{
"gwLbID": "xxxxxxx",
"name": "xxx",
"description": "xxx",
"vpcID": "vpc-xx",
"subnetID": "subnet-xx",
"portID": "port-xx",
"ipv6Enabled": false,
"ipv6Address": "",
"privateIpAddress": "192.168.0.1",
"deleteProtection": false,
"slaName": "elb.default",
"createdAt": "2023-12-18 10:00:00",
"updatedAt": "2023-12-18 11:00:00"
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
