首页 负载均衡 传统型负载均衡CLB 开发参考 API参考 API目录 虚拟服务器组 SetVServerGroupAttribute - 修改虚拟服务器组的配置

SetVServerGroupAttribute - 修改虚拟服务器组的配置

更新时间: 2023-09-28 12:15:40

修改虚拟服务器组的配置。

接口说明

该接口只能用于修改后端服务器的权重和虚拟服务器名称:

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:SetVServerGroupAttributeWRITE
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag

请求参数

名称类型必填描述示例值
RegionIdstring

负载均衡地域ID,不可更改。

cn-hangzhou
VServerGroupIdstring

后端服务器组ID,不可更改。

rsp-cige6****
VServerGroupNamestring

虚拟服务器组名称,可自定义更改。

Group1
BackendServersstring

虚拟服务器组列表,单次最多可添加20个后端服务器。

  • ServerId:String类型,必选,后端服务器的实例ID或ENI实例ID。

  • Port:Integer类型,必选,后端服务器使用的端口,取值范围:1~65535

  • Weight(可更改):Integer类型,必选,后端服务器的权重,取值范围:0~100

  • **Description **(可更改):String类型,非必选,后端服务器描述,长度为1~80个字符,允许包含字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_),支持中文。

  • Type:String类型,表示后端服务器的实例类型,取值:

    • ecs: ECS实例(默认)。

    • eni:弹性网卡实例。

  • ServerIp:ECS或者ENI的实例IP。

示例如下:

  • 挂载ECS示例:

[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port":"80","Description":"test-112" }]

  • 挂载ENI:

    [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" }]

  • 挂载ENI多IP:

[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port":"80","Description":"test-113" }]

[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.XX.XX.6", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.XX.XX.6", "Port":"80","Description":"test-113" }]

返回参数

名称类型描述示例值
object
VServerGroupIdstring

服务器组ID。

rsp-cige6****
VServerGroupNamestring

虚拟服务器组名称。

Group1
RequestIdstring

请求ID。

9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
BackendServersobject []

后端服务器列表。

Typestring

后端服务器类型,取值:

  • ecs:ECS实例。

  • eni:弹性网卡实例。

ecs
Weightinteger

后端服务器的权重。

100
Descriptionstring

后端服务器组描述。

后端服务器组描述。
Portinteger

后端服务器使用的端口。

70
ServerIdstring

ECS实例ID或ENI实例ID。

i-bp1ek6yd7jvkx****

示例

正常返回示例

JSON格式

{
  "VServerGroupId": "rsp-cige6****",
  "VServerGroupName": "Group1",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 100,
        "Description": "后端服务器组描述。",
        "Port": 70,
        "ServerId": "i-bp1ek6yd7jvkx****"
      }
    ]
  }
}

JSON格式

{
  "VServerGroupId": "rsp-cige6****",
  "VServerGroupName": "Group1",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 100,
        "Description": "后端服务器组描述。",
        "Port": 70,
        "ServerId": "i-bp1ek6yd7jvkx****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe VServerGroupName or BackendServers is required at lease one.参数VServerGroupName和BackendServers至少需要配置一个。

访问错误中心查看更多错误码。

阿里云首页 负载均衡 相关技术圈