创建gwlb
更新时间 2026-05-26 15:50:23
最近更新时间: 2026-05-26 15:50:23
接口功能介绍
创建网关负载均衡
接口约束
无
URI
POST /v4/gwlb/create
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | xxxxxx | |
| projectID | 否 | String | 企业项目ID，默认"0" | 0 | |
| subnetID | 是 | String | 子网 ID | subnet-xxx | |
| name | 是 | String | 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | test | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符：~!@#$%^&()_-+= <>?:"{},./;'[]·！@#￥%……&（） —— -+={}\《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 - 128 | desc | |
| privateIpAddress | 否 | String | 私有 ip 地址 | 193.3.33.3 | |
| ipv6Address | 否 | String | ipv6 地址 | 2001:db8:85a3::8a2e:370:7334 | |
| deleteProtection | 否 | Boolean | 是否开启删除保护，默认为 False | true | |
| ipv6Enabled | 否 | Boolean | 是否开启 ipv6，默认为 False | true | |
| cycleType | 是 | String | 仅支持按需 | on_demand | |
| payVoucherPrice | 否 | String | 代金券金额，支持到小数点后两位 | 300 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单id。 | 55d531d7bf2d47658897c42ffb918423 | |
| masterOrderNO | String | 订单编号, 可以为 null。 | 20221021191602644224 | |
| masterResourceStatus | String | 资源状态: started（启用） / renewed（续订） / refunded（退订） / destroyed（销毁） / failed（失败） / starting（正在启用） / changed（变配）/ expired（过期）/ unknown（未知） | started | |
| masterResourceID | String | 资源 ID 可以为 null。 | d48cace2da7b4c81b4c0444768a04608 | |
| regionID | String | 可用区id。 | 81f7728662dd11ec810800155d307d5b | |
| gwLbID | String | 网关负载均衡 ID | gwlb-xxx |
枚举参数
无
请求示例
请求url
POST /openapi/v4/gwlb/create
请求头header
无
请求体body
{
"regionID": "xxxx",
"name": "eip-test-0001234",
"subnetID": "subnet-xxxx",
"clientToken": "xxxxxxxx",
"cycleType": "on_demand"
}
响应示例
#### 成功响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description": "成功",
"returnObj":{
"masterOrderID": "ee508bcc586211ed961bacde48001122",
"masterOrderNO": null,
"masterResourceID": "d48cace2da7b4c81b4c0444768a04608",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"gwLbID": "xxxxxx"
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
