接口功能介绍
创建后端服务组
接口约束
无
URI
POST /v4/elb/create-target-group
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
protocol | 否 | String | 支持 TCP / UDP / HTTP / HTTPS | ||
regionID | 是 | String | 区域ID | ||
name | 是 | String | 唯一。支持拉丁字母、中文、数字,下划线,连字符,中文 / 英文字母开头,不能以 http: / https: 开头,长度 2 - 32 | acl11 | |
description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符: |
《》?:“”【】、;‘',。、,不能以 http: / https: 开头,长度 0 - 128 | acl |
vpcID | 是 | String | vpc ID | ||
healthCheckID | 否 | String | 健康检查ID | ||
algorithm | 是 | String | 调度算法。取值范围:rr(轮询)、wrr(带权重轮询)、lc(最少连接)、sh(源IP哈希) | ||
sessionSticky | 否 | Object | 会话保持配置 | Array of Objects | sessionSticky |
表 sessionSticky
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sessionStictyMode | 是 | String | 会话保持模式,支持取值:CLOSE(关闭)、INSERT(插入)、REWRITE(重写),当 algorithm 为 lc / sh 时,sessionStictyMode 必须为 CLOSE | ||
cookieExpire | 否 | Integer | cookie过期时间。INSERT模式必填 | 1 | |
rewriteCookieName | 否 | String | cookie重写名称,REWRITE模式必填 | test | |
sourceIpTimeout | 否 | Integer | 源IP会话保持超时时间。SOURCE_IP模式必填 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | Array of Objects | 接口业务数据 | returnObj | |
error | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
ID | String | 后端服务组ID | target-49bp8uzydb |
枚举参数
无
请求示例
请求url
POST /v4/elb/create-target-group
请求头header
无
请求体body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "yacos_test",
"description": "yacos_test",
"vpcID": "vpc-mv4gqflr2x",
"algorithm": "wrr",
"sessionSticky": {
"sessionStictyMode": "REWRITE",
"rewriteCookieName": "test"
},
"healthCheckID": "hc-6v5rhm7m27"
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": [
{
"ID": "target-49bp8uzydb"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码