接口功能介绍
创建经典型负载均衡实例。
接口约束
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息,如资源池概况信息查询结果为"regionVersion":"v4.0",即可使用;如资源池概况信息结果为"regionVersion":"v3.0",请使用API(旧版)内接口创建负载均衡实例(旧版)。
URI
POST /v4/elb/create-loadbalancer
请求参数
请求体Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一(预留参数,暂无用) | |
regionID | String | 是 | 区域ID | |
azName | String | 否 | 可用区名称 | |
projectID | String | 否 | 企业项目ID,默认为"0" | 0 |
vpcID | String | 否 | vpc的ID | |
subnetID | String | 是 | 子网的ID | |
name | String | 是 | 名称,唯一。支持拉丁字母、中文、数字,下划线,连字符,中文 / 英文字母开头,不能以 http: / https: 开头,长度 2 - 32 | |
description | String | 否 | 支持拉丁字母、中文、数字, 特殊字符: |
|
eipID | String | 否 | 弹性公网IP的ID。当resourceType=external为必填 | |
slaName | String | 是 | lb的规格名称(暂不支持配置,可使用默认名称,如示例)) | elb.small.s1 |
resourceType | String | 是 | 资源类型。internal:内网负载均衡,external:公网负载均衡 | |
privateIpAddress | String | 否 | 负载均衡的私有IP地址,不指定则自动分配 | |
deleteProtection | Boolean | 否 | 删除保护。false(不开启)、true(开)。 默认:不开启 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | 错误信息的英文描述 | |
description | String | 返回信息说明,如果请求成功,返回空字符串;否则为错误信息。 | |
errCode | String | 错误描述 | |
returnObj | Object | 接口业务数据 |
表 returnObj
参数 | 参数类型 | 说明 |
---|---|---|
ID | String | 负载均衡ID |
请求示例
POST /v4/elb/create-loadbalancer
请求体body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"subnetID": "subnet-23k8nuci7z",
"name": "yacos_lb_test_ipv6",
"description": "yacos_lb_test_ipv6",
"resourceType": "internal",
"privateIpAddress": "10.10.0.10",
"slaName": "elb.s1.small"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"ID": "lb-f1vo2qd2js"
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。