在指定地域创建服务器组。
接口说明
使用说明
CreateServerGroup接口属于异步接口,即系统返回一个请求ID,但该服务器组尚未创建成功,系统后台的创建任务仍在进行。您可以调用ListServerGroups查询服务器组的创建状态:
- 当服务器组处于Creating状态时,表示服务器组正在创建中。
- 当服务器组处于Available状态时,表示服务器组创建成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alb:CreateServerGroup | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerGroupName | string | 是 | 服务器组名称。长度为2~128个字符,必须以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 | sg-atstuj3rtoptyui**** |
ServerGroupType | string | 否 | 服务器组类型。取值:
| Instance |
VpcId | string | 否 | VPC实例ID。只有该VPC下的服务器可以加入到该服务器组。 说明
ServerGroupType取值为Instance或Ip时,该参数生效。
| vpc-bp15zckdt37pq72zv**** |
Scheduler | string | 否 | 调度算法。取值:
说明
ServerGroupType取值为Instance或Ip时,该参数生效。
| Wrr |
Protocol | string | 否 | 后端协议。取值:
说明
ServerGroupType取值为Fc时,仅支持HTTP协议。
| HTTP |
ResourceGroupId | string | 否 | 资源组ID。 | rg-atstuj3rtop**** |
HealthCheckConfig | object | 是 | 健康检查相关配置。 | |
HealthCheckConnectPort | integer | 否 | 健康检查的后端服务器的端口。 取值范围: 0~65535。 默认值:0,表示使用后端服务器的端口进行健康检查。 | 80 |
HealthCheckEnabled | boolean | 是 | 是否开启健康检查,取值:
说明
ServerGroupType取值为Instance或Ip时,默认开启健康检查。ServerGroupType取值为Fc时,默认不开启健康检查。
| true |
HealthCheckHost | string | 否 | 健康检查域名。字符要求:
说明
只有HealthCheckProtocol设置为HTTP时,该参数生效。
| www.example.com |
HealthCheckCodes | array | 否 | 健康检查正常的状态码列表。 | |
string | 否 | 健康检查正常的状态码。
说明
HealthCheckProtocol为HTTP或gRPC,该参数生效。
| http_2xx | |
HealthCheckHttpVersion | string | 否 | 健康检查HTTP协议版本,取值:HTTP1.0或HTTP1.1(默认值)。 说明
只有HealthCheckProtocol设置为HTTP时,该参数生效。
| HTTP1.1 |
HealthCheckInterval | integer | 否 | 健康检查的时间间隔。单位:秒。 取值范围:1~50。 默认值:2。 | 2 |
HealthCheckMethod | string | 否 | 健康检查方法,取值:
说明
只有HealthCheckProtocol设置为HTTP或gRPC时,该参数生效。
| HEAD |
HealthCheckPath | string | 否 | 健康检查的转发规则路径。 长度为1~80个字符,只能使用字母、数字、字符 说明
只有HealthCheckProtocol设置为HTTP时,该参数生效。
| /test/index.html |
HealthCheckProtocol | string | 否 | 健康检查协议,取值:
| HTTP |
HealthCheckTimeout | integer | 否 | 接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应,则判定为健康检查失败。单位:秒。 取值范围:1~300。 默认值:5。 说明
如果HealthCHeckTimeout的值小于HealthCheckInterval的值,则HealthCHeckTimeout无效,超时时间为HealthCheckInterval的值。
| 5 |
HealthyThreshold | integer | 否 | 健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功。 取值范围:2~10。 默认值:3。 | 3 |
UnhealthyThreshold | integer | 否 | 健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败。 取值范围:2~10。 默认值:3。 | 3 |
StickySessionConfig | object | 否 | 会话保持配置结构体。 说明
ServerGroupType取值为Instance或Ip时,该参数生效。
| |
Cookie | string | 否 | 服务器上配置的Cookie。 长度为1~200个字符,只能包含ASCII英文字母和数字字符,不能包含半角逗号(,)、半角分号(;)或空格,也不能以美元符号($)开头。 说明
当StickySessionEnabled为true且StickySessionType为server时,该参数生效。
| B490B5EBF6F3CD402E515D22BCDA**** |
CookieTimeout | integer | 否 | Cookie超时时间。单位:秒。 取值范围:1~86400。 默认值:1000。 说明
当StickySessionEnabled为true且StickySessionType为Insert时,该参数生效。
| 1000 |
StickySessionEnabled | boolean | 否 | 是否启用会话保持,取值:
说明
ServerGroupType取值为Instance或Ip时,该参数生效。
| false |
StickySessionType | string | 否 | Cookie的处理方式。取值:
说明
当StickySessionEnabled的值为true时,该参数生效。
| Insert |
ClientToken | string | 否 | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明
若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| false |
ServiceName | string | 否 | 仅适用于ALB Ingress场景,表示服务器组对应的 | test |
UchConfig | object | 否 | url一致性hash参数配置 | |
Type | string | 是 | 参数类型 | QueryString |
Value | string | 是 | 一致性hash参数值 | abc |
返回参数
示例
正常返回示例
JSON
格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
"ServerGroupId": "sg-atstuj3rtoptyui****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | QuotaExceeded.ServerGroupsNum | The quota of %s is exceeded, usage %s/%s. | 配额%s已超额度限制,目前已使用%s,配额为%s。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-04-11 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||
|