更新时间:2024-09-26 GMT+08:00

批量更新后端服务器

功能介绍

在指定pool下批量更新后端服务器。一次最多添加200个。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/elb/pools/{pool_id}/members/batch-update

表1 路径参数

参数

是否必选

参数类型

描述

pool_id

String

参数解释:后端服务器组ID。

project_id

String

参数解释:项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

members

Array of BatchUpdateMembersOption objects

后端服务器对象。

表4 BatchUpdateMembersOption

参数

是否必选

参数类型

描述

id

String

后端服务器ID。

说明:

此处并非ECS服务器的ID,而是ELB为绑定的后端服务器自动生成的member ID。

admin_state_up

Boolean

后端服务器的管理状态。取值:true、false。

虽然创建、更新请求支持该字段,但实际取值决定于后端服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。

请勿传入该字段。

name

String

后端服务器名称。

protocol_port

Integer

后端服务器端口。

在开启端口透传的pool下的member,该字段无法更新。

weight

Integer

后端服务器的权重,请求按权重在同一后端服务器组下的后端服务器间分发。权重为0的后端不再接受新的请求。当后端服务器所在的后端服务器组的lb_algorithm的取值为SOURCE_IP时,该字段无效。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

注:自动生成 。

members

Array of BatchUpdateMember objects

后端服务器对象列表。

表6 BatchUpdateMember

参数

参数类型

描述

id

String

后端服务器ID。

说明:

说明:

此处并非ECS服务器的ID,而是ELB为绑定的后端服务器自动生成的member ID。

name

String

后端服务器名称。

project_id

String

后端服务器所在的项目ID。

admin_state_up

Boolean

后端服务器的管理状态。取值:true、false。

虽然创建、更新请求支持该字段,但实际取值决定于后端服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。

subnet_cidr_id

String

后端服务器所在的子网,可以是IPv4或IPv6子网。若是IPv4子网,使用对应子网的子网ID(neutron_subnet_id);若是IPv6子网,使用对应子网的网络ID(neutron_network_id)。

ipv4子网的子网ID可以通过GET

https://{VPC_Endpoint}/v1/{project_id}/subnets

响应参数中的neutron_subnet_id得到

ipv6子网的网络ID可以通过GET

https://{VPC_Endpoint}/v1/{project_id}/subnets

响应参数中的neutron_network_id得到

使用说明:

  • 该子网和关联的负载均衡器的子网必须在同一VPC下。

  • 若所属LB的跨VPC后端转发已开启(ip_target_enable=true),则该字段可以不传,表示添加跨VPC的后端服务器。此时address必须为IPv4地址,所在的pool的协议必须为UDP/TCP/TLS/HTTP/HTTPS/QUIC/GRPC。

  • 若所属LB未开启跨VPC后端转发,该参数必填。

protocol_port

Integer

后端服务器业务端口。

说明:

在开启端口透传的pool下创建member传该字段不生效,可不传该字段。

weight

Integer

后端服务器的权重,请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。权重值越大,分发的请求越多。权重为0的后端不再接受新的请求。

取值:0-100,默认1。

使用说明:

  • 若所在pool的lb_algorithm取值为SOURCE_IP或QUIC_CID,该字段无效。

address

String

后端服务器对应的IP地址。

使用说明:

  • 若subnet_cidr_id为空,表示添加跨VPC后端,此时address必须为IPv4地址。

  • 若subnet_cidr_id不为空,表示是一个关联到ECS的后端服务器。该IP地址可以是私网IPv4或IPv6。但必须在subnet_cidr_id对应的子网网段中。

operating_status

String

后端服务器的健康状态。取值:

  • ONLINE:后端服务器正常。

  • NO_MONITOR:后端服务器所在的服务器组没有健康检查器。

  • OFFLINE:后端服务器关联的ECS服务器不存在或已关机。

status

Array of MemberStatus objects

后端服务器监听器粒度的的健康状态。

若绑定的监听器在该字段中,则以该字段中监听器对应的operating_stauts为准。

若绑定的监听器不在该字段中,则以外层的operating_status为准。

member_type

String

后端服务器的类型。取值:

  • ip:跨VPC的member。

  • instance:关联到ECS的member。

instance_id

String

member关联的实例ID,空表示跨VPC场景的member。

port_id

String

IP地址对应的VPC port ID

created_at

String

创建时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。

注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。

updated_at

String

更新时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。

注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。

表7 MemberStatus

参数

参数类型

描述

listener_id

String

参数解释:监听器ID

operating_status

String

参数解释:后端服务器的健康状态。

取值范围:

  • ONLINE:后端服务器正常。

  • NO_MONITOR:后端服务器所在的服务器组没有健康检查器。

  • OFFLINE:后端服务器关联的ECS服务器不存在或已关机。

请求示例

批量更新后端服务器。

POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-update

{
  "members" : [ {
    "name" : "batch_update_member1",
    "weight" : 1,
    "admin_state_up" : true,
    "protocol_port" : 8080,
    "id" : "61da8098-954b-4809-bc5a-b99ccef8a398"
  }, {
    "name" : "batch_update_member2",
    "weight" : 2,
    "admin_state_up" : true,
    "protocol_port" : 8081,
    "id" : "61da8098-954b-4809-bc5a-b99ccef8a398"
  } ]
}

响应示例

状态码: 200

操作正常返回。

{
  "request_id" : "b5d8bb34d28f3e47b352c14419e8fe04",
  "members" : [ {
    "weight" : 1,
    "admin_state_up" : false,
    "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d",
    "address" : "192.168.0.48",
    "protocol_port" : 8080,
    "id" : "9346ad28-6971-456a-9711-2917d023930a",
    "operating_status" : "OFFLINE",
    "name" : "batch_member1",
    "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398"
  }, {
    "weight" : 1,
    "admin_state_up" : false,
    "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d",
    "address" : "192.168.0.49",
    "protocol_port" : 8080,
    "id" : "94548801-1023-452f-bcf7-6174e77cb772",
    "operating_status" : "OFFLINE",
    "name" : "batch_member2",
    "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398"
  } ]
}

SDK代码示例

SDK代码示例如下。

批量更新后端服务器。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchUpdateMembersSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchUpdateMembersRequest request = new BatchUpdateMembersRequest();
        request.withPoolId("{pool_id}");
        BatchUpdateMembersRequestBody body = new BatchUpdateMembersRequestBody();
        List<BatchUpdateMembersOption> listbodyMembers = new ArrayList<>();
        listbodyMembers.add(
            new BatchUpdateMembersOption()
                .withId("61da8098-954b-4809-bc5a-b99ccef8a398")
                .withAdminStateUp(true)
                .withName("batch_update_member1")
                .withProtocolPort(8080)
                .withWeight(1)
        );
        listbodyMembers.add(
            new BatchUpdateMembersOption()
                .withId("61da8098-954b-4809-bc5a-b99ccef8a398")
                .withAdminStateUp(true)
                .withName("batch_update_member2")
                .withProtocolPort(8081)
                .withWeight(2)
        );
        body.withMembers(listbodyMembers);
        request.withBody(body);
        try {
            BatchUpdateMembersResponse response = client.batchUpdateMembers(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

批量更新后端服务器。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchUpdateMembersRequest()
        request.pool_id = "{pool_id}"
        listMembersbody = [
            BatchUpdateMembersOption(
                id="61da8098-954b-4809-bc5a-b99ccef8a398",
                admin_state_up=True,
                name="batch_update_member1",
                protocol_port=8080,
                weight=1
            ),
            BatchUpdateMembersOption(
                id="61da8098-954b-4809-bc5a-b99ccef8a398",
                admin_state_up=True,
                name="batch_update_member2",
                protocol_port=8081,
                weight=2
            )
        ]
        request.body = BatchUpdateMembersRequestBody(
            members=listMembersbody
        )
        response = client.batch_update_members(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

批量更新后端服务器。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchUpdateMembersRequest{}
	request.PoolId = "{pool_id}"
	adminStateUpMembers:= true
	nameMembers:= "batch_update_member1"
	protocolPortMembers:= int32(8080)
	weightMembers:= int32(1)
	adminStateUpMembers1:= true
	nameMembers1:= "batch_update_member2"
	protocolPortMembers1:= int32(8081)
	weightMembers1:= int32(2)
	var listMembersbody = []model.BatchUpdateMembersOption{
        {
            Id: "61da8098-954b-4809-bc5a-b99ccef8a398",
            AdminStateUp: &adminStateUpMembers,
            Name: &nameMembers,
            ProtocolPort: &protocolPortMembers,
            Weight: &weightMembers,
        },
        {
            Id: "61da8098-954b-4809-bc5a-b99ccef8a398",
            AdminStateUp: &adminStateUpMembers1,
            Name: &nameMembers1,
            ProtocolPort: &protocolPortMembers1,
            Weight: &weightMembers1,
        },
    }
	request.Body = &model.BatchUpdateMembersRequestBody{
		Members: listMembersbody,
	}
	response, err := client.BatchUpdateMembers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码