创建负载均衡服务器组。
接口说明
CreateServerGroup 接口属于异步接口,即系统返回一个请求 ID,但该服务器组尚未创建成功,系统后台的创建任务仍在进行。您可以调用 ListServerGroups 查询服务器组的创建状态:
- 当服务器组处于 Creating 状态时,表示服务器组正在创建中。
- 当服务器组处于 Available 状态时,表示服务器组创建成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gwlb:CreateServerGroup | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerGroupType | string | 否 | 服务器组类型。取值:
| Instance |
ServerGroupName | string | 否 | 服务器组名称。 长度为 2~128 个字符,必须以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 | testServerGroupName |
Protocol | string | 否 | 后端转发协议。取值:
| GENEVE |
Scheduler | string | 否 | 调度算法。取值:
| 5TCH |
VpcId | string | 是 | VPC 实例 ID。 说明
如果 ServerGroupType 取值为 Instance 时,只有该 VPC 下的服务器可以加入到该服务器组。
| vpc-bp15zckdt37pq72zv**** |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-atstuj3rtop**** |
ConnectionDrainConfig | object | 否 | 连接优雅中断相关配置。 | |
ConnectionDrainEnabled | boolean | 否 | 是否开启连接优雅中断。取值:
| false |
ConnectionDrainTimeout | integer | 否 | 连接优雅中断超时时间。 单位:秒。 取值范围:1~3600。 默认值:300。 | 300 |
HealthCheckConfig | object | 否 | 健康检查相关配置。 | |
HealthCheckConnectPort | integer | 否 | 健康检查使用的后端服务器的端口。 取值范围: 1~65535。 默认值:80。 | 80 |
HealthCheckConnectTimeout | integer | 否 | 健康检查响应的最大超时时间。 单位:秒。 取值范围:1~300。 默认值:5。 | 5 |
HealthCheckDomain | string | 否 | 用于健康检查的域名。取值:
说明
仅 HealthCheckProtocol 为 HTTP 时,该参数生效。
| $SERVER_IP |
HealthCheckEnabled | boolean | 否 | 是否开启健康检查,取值:
| true |
HealthCheckHttpCode | array | 否 | 健康状态返回码列表。 | |
HealthCheckHttpCode | string | 否 | 健康状态返回码,多个状态码用半角逗号(,)分隔。 取值:
默认值:http_2xx 。 说明
仅 HealthCheckProtocol 为 HTTP 时,该参数生效。
| http_2xx |
HealthCheckInterval | integer | 否 | 健康检查的时间间隔。 单位:秒。 取值范围:1~50。 默认值:10。 | 10 |
HealthCheckPath | string | 否 | 健康检查路径。 长度为 1~80 个字符,只能使用大小写英文字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和 and(&)以及扩展字符集_;~!()*[]@$^:',+= 必须以正斜线(/)开头。 说明
仅 HealthCheckProtocol 为 HTTP 时,该参数生效。
| /test/index.html |
HealthCheckProtocol | string | 否 | 健康检查协议,取值:
| TCP |
HealthyThreshold | integer | 否 | 健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功。 取值范围:2~10。 默认值:2。 | 2 |
UnhealthyThreshold | integer | 否 | 健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败。 取值范围:2~10。 默认值:2。 | 2 |
Tag | array<object> | 否 | 标签列表。 一次调用最多支持 20 个标签。 | |
TagModel | object | 否 | 标签。 | |
Key | string | 否 | 标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 | testTagKey |
Value | string | 否 | 标签值。最多支持 256 个字符,不能包含 | testTagValue |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| False |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-42665544**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroupId": "sgp-atstuj3rtoptyui****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.HealthCheckProtocol | The param of %s is illegal. | 健康检查协议非法,请检查输入参数。 |
400 | QuotaExceeded.ServerGroupsNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配额gwlb_quota_servergroups_num已超额度限制。 |
400 | DuplicatedParam.TagKey | The param of %s is duplicated. | 标签键参数重复 |
400 | IllegalParam.TagKey | The param of %s is illegal. | 标签键参数值不合法 |
404 | ResourceNotFound.Vpc | The specified resource of %s is not found. | 指定的专有网络资源不存在。 |
访问错误中心查看更多错误码。