yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
main
doc-exports/docs/elb/api-ref/CreateMember.html
zhoumeng 79a6901263 ELB_API_20251118_Version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: zhoumeng <zhoumeng35@huawei.com>
Co-committed-by: zhoumeng <zhoumeng35@huawei.com>
2025-12-04 21:11:56 +00:00

558 lines
34 KiB
HTML
Raw Permalink Blame History

<a name="CreateMember"></a><a name="CreateMember"></a>
<h1 class="topictitle1">Adding a Backend Server</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add a backend server.</p>
</div>
<div class="section"><h4 class="sectiontitle">Constraints</h4><p>When you add backend servers, note the following:</p>
<ul><li><p>Two backend servers in the same backend server group must have different IP addresses and ports.</p>
</li><li><p>If no subnets are specified during cloud server creation, IP as backend servers can be added. In this case, <strong>address</strong> must be set to an IPv4 address, the protocol of the backend server group must be TCP, HTTP, or HTTPS, and <strong>IP as a Backend</strong> must have been enabled for the load balancer.</p>
</li><li><p>If a subnet is specified during cloud server creation, the subnet must be in the same VPC where the load balancer resides.</p>
</li><li><p>If the backend server group supports IPv4/IPv6 dual stack, <strong>address</strong> can be an IPv4 address or an IPv6 address. If the backend server group supports only IPv4, <strong>address</strong> can only be an IPv4 address.</p>
</li></ul>
</div>
<div class="section" id="CreateMember__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v3/{project_id}/elb/pools/{pool_id}/members</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Specifies the ID of the backend server group.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p>Specifies the token used for IAM authentication.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__request_CreateMemberRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p>member</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p><a href="#CreateMember__request_CreateMemberOption">CreateMemberOption</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p>Specifies the backend server.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateMember__request_CreateMemberOption"></a><a name="request_CreateMemberOption"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__request_CreateMemberOption" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateMemberOption</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the private IP address bound to the backend server.</p>
<ul><li><p>If <strong>subnet_cidr_id</strong> is left blank, <strong>IP as a Backend</strong> is enabled. In this case, the IP address must be an IPv4 address.</p>
</li><li><p>If <strong>subnet_cidr_id</strong> is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by <strong>subnet_cidr_id</strong> and can only be bound to the primary NIC of the backend server.</p>
</li></ul>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the administrative status of the backend server. The value can be <strong>true</strong> or <strong>false</strong>.</p>
<p>Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is <strong>true</strong>. Otherwise, the value is <strong>false</strong>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the backend server name.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>255</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the project ID.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>32</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the port used by the backend server to receive requests.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>65535</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>subnet_cidr_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides.</p>
<p>Note:</p>
<ul><li><p>The IPv4 or IPv6 subnet must be in the same VPC as the subnet of the load balancer.</p>
</li><li><p>If this parameter is not passed, <strong>IP as a Backend</strong> has been enabled for the load balancer. In this case, IP as backend servers must use private IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.</p>
</li></ul>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>36</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>weight</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p>Specifies the weight of the backend server. Requests are routed to backend servers in the same backend server group based on their weights.</p>
<p>The value ranges from <strong>0</strong> to <strong>100</strong>, and the default value is <strong>1</strong>. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.</p>
<p>If <strong>lb_algorithm</strong> is set to <strong>SOURCE_IP</strong>, this parameter will not take effect.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p><strong>Definition</strong>: Specifies the AZ of the backend server.</p>
<p><strong>Constraints</strong>:</p>
<ul><li><p>This parameter can be only set for IP as backend servers. If AZ affinity is enabled for the backend server group, this parameter must be set to a valid value for IP as backend servers.</p>
</li></ul>
<p><strong>Range</strong>: AZs available for ECSs in the current region.</p>
<p><strong>Default value</strong>: N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__response_CreateMemberResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p>Specifies the request ID. The value is automatically generated.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>member</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#CreateMember__response_Member">Member</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p>Specifies the backend server.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateMember__response_Member"></a><a name="response_Member"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__response_Member" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Member</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the backend server ID.</p>
<p>Note:</p>
<p>The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>: Specifies the AZ of the backend server.</p>
<p><strong>Default value</strong>: N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the backend server name.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the project ID of the backend server.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the administrative status of the backend server. The value can be <strong>true</strong> or <strong>false</strong>.</p>
<p>Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is <strong>true</strong>. Otherwise, the value is <strong>false</strong>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>subnet_cidr_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides.</p>
<p>This parameter can be left blank, indicating that <strong>IP as a Backend</strong> has been enabled for the load balancer. In this case, IP addresses of these servers must be IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.</p>
<p>The IPv4 or IPv6 subnet must be in the same VPC as the subnet of the load balancer.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the port used by the backend server to receive requests.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>65535</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>weight</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the weight of the backend server. Requests are routed to backend servers in the same backend server group based on their weights.</p>
<p>The value ranges from <strong>0</strong> to <strong>100</strong>, and the default value is <strong>1</strong>. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.</p>
<p>If <strong>lb_algorithm</strong> is set to <strong>SOURCE_IP</strong>, this parameter will not take effect.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>100</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>address</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the private IP address bound to the backend server.</p>
<ul><li><p>If <strong>subnet_cidr_id</strong> is left blank, <strong>IP as a Backend</strong> is enabled. In this case, the IP address must be an IPv4 address.</p>
</li><li><p>If <strong>subnet_cidr_id</strong> is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by <strong>subnet_cidr_id</strong> and can only be bound to the primary NIC of the backend server.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the IP version supported by the backend server. The value can be <strong>v4</strong> (IPv4) or <strong>v6</strong> (IPv6), depending on the value of <strong>address</strong> returned by the system.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>operating_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the health status of the backend server. The value can be one of the following:</p>
<ul><li><p><strong>ONLINE</strong>: The backend server is running normally.</p>
</li><li><p><strong>NO_MONITOR</strong>: No health check is configured for the backend server group to which the backend server belongs.</p>
</li><li><p><strong>OFFLINE</strong>: The cloud server used as the backend server is stopped or does not exist.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Array of <a href="#CreateMember__response_MemberStatus">MemberStatus</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the health status of the backend server if <strong>listener_id</strong> under <strong>status</strong> is specified. If <strong>listener_id</strong> under <strong>status</strong> is not specified, <strong>operating_status</strong> of <strong>member</strong> takes precedence.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).</p>
<p>This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).</p>
<p>This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>member_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the type of the backend server. Values:</p>
<ul><li><p><strong>ip</strong>: IP as backend servers</p>
</li><li><p><strong>instance</strong>: ECSs used as backend servers</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateMember__response_MemberStatus"></a><a name="response_MemberStatus"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__response_MemberStatus" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MemberStatus</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>listener_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the listener ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>operating_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the health status of the backend server. The value can be one of the following:</p>
<ul><li><p><strong>ONLINE</strong>: The backend server is running normally.</p>
</li><li><p><strong>NO_MONITOR</strong>: No health check is configured for the backend server group to which the backend server belongs.</p>
</li><li><p><strong>OFFLINE</strong>: The cloud server used as the backend server is stopped or does not exist.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>reason</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p><a href="#CreateMember__response_MemberHealthCheckFailedReason">MemberHealthCheckFailedReason</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>: Specifies the operating status of the backend server.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>: Specifies the creation time. The value must be a UTC time in the format of <em>yyyy-MM-dd'T'HH:mm:ss'Z'</em>.</p>
<p><strong>Range</strong>: N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>: Specifies the update time. The value must be a UTC time in the format of <em>yyyy-MM-dd'T'HH:mm:ss'Z'</em>.</p>
<p><strong>Range</strong>: N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateMember__response_MemberHealthCheckFailedReason"></a><a name="response_MemberHealthCheckFailedReason"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__response_MemberHealthCheckFailedReason" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MemberHealthCheckFailedReason</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>reason_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>: Specifies the code of the health check failures.</p>
<p><strong>Range</strong>:</p>
<ul><li><p><strong>CONNECT_TIMEOUT</strong>: The connection with the backend server times out during a health check.</p>
</li><li><p><strong>CONNECT_REFUSED</strong>: The load balancer rejects connections with the backend server during a health check.</p>
</li><li><p><strong>CONNECT_FAILED</strong>: The load balancer fails to establish connections with the backend server during a health check.</p>
</li><li><p><strong>CONNECT_INTERRUPT</strong>: The load balancer is disconnected from the backend server during a health check.</p>
</li><li><p><strong>SSL_HANDSHAKE_ERROR</strong>: The SSL handshakes with the backend server fail during a health check.</p>
</li><li><p><strong>RECV_RESPONSE_FAILED</strong>: The load balancer fails to receive responses from the backend server during a health check.</p>
</li><li><p><strong>RECV_RESPONSE_TIMEOUT</strong>: The load balancer does not receive responses from the backend server within the timeout duration during a health check.</p>
</li><li><p><strong>SEND_REQUEST_FAILED</strong>: The load balancer fails to send a health check request to the backend server during a health check.</p>
</li><li><p><strong>SEND_REQUEST_TIMEOUT</strong>: The load balancer fails to send a health check request to the backend server within the timeout duration.</p>
</li><li><p><strong>RESPONSE_FORMAT_ERROR</strong>: The load balancer receives invalid responses from the backend server during a health check.</p>
</li><li><p><strong>RESPONSE_MISMATCH</strong>: The response code received from the backend server is different from the preset code.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>expected_response</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>: Specifies the expected HTTP status code. This parameter will take effect only when <strong>type</strong> is set to <strong>HTTP</strong>, <strong>HTTPS</strong>, or <strong>GRPC</strong>. The status code cannot be <strong>null</strong> if <strong>reason_code</strong> is <strong>RESPONSE_MISMATCH</strong>.</p>
<p><strong>Range</strong>:</p>
<ul><li><p>A specific status code. The status code ranges from 200 to 599. For example, the status code can be <strong>0</strong> or <strong>200</strong>.</p>
</li><li><p>A list of status codes that are separated with commas (,), for example, <strong>200,202</strong> or <strong>0,1</strong>. A maximum of five status codes are supported.</p>
</li><li><p>A status code range. Different ranges are separated with commas (,), for example, <strong>200-204,300-399</strong> or <strong>0-5,10-12,20-30</strong>. A maximum of five ranges are supported.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>healthcheck_response</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>: Specifies the returned HTTP status code in the response. This parameter will take effect only when <strong>type</strong> is set to <strong>HTTP</strong>, <strong>HTTPS</strong>, or <strong>GRPC</strong>. The status code cannot be <strong>null</strong> if <strong>reason_code</strong> is <strong>RESPONSE_MISMATCH</strong>.</p>
<p><strong>Range</strong>:</p>
<ul><li><p>A specific status code. The status code ranges from 200 to 599. For example, the status code can be <strong>0</strong> or <strong>200</strong>.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><ul><li><p>Example 1: Adding a backend server</p>
<pre class="screen">POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members
{
"member" : {
"subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
"protocol_port" : 89,
"name" : "My member",
"address" : "120.10.10.16"
}
}</pre>
</li><li><p>Example 2: Adding an IP as a backend server</p>
<pre class="screen">POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members
{
"member" : {
"protocol_port" : 89,
"name" : "My member",
"address" : "120.10.10.16"
}
}</pre>
</li></ul>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 201</strong></p>
<p>Normal response to POST requests.</p>
<pre class="screen">{
"member" : {
"name" : "My member",
"weight" : 1,
"admin_state_up" : false,
"subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
"project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
"address" : "120.10.10.16",
"protocol_port" : 89,
"id" : "1923923e-fe8a-484f-bdbc-e11559b1f48f",
"operating_status" : "NO_MONITOR",
"status" : [ {
"listener_id" : "427eee03-b569-4d6c-b1f1-712032f7ec2d",
"operating_status" : "NO_MONITOR"
} ],
"ip_version" : "v4"
},
"request_id" : "f354090d-41db-41e0-89c6-7a943ec50792"
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateMember__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Normal response to POST requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="module_members.html">Backend Server</a></div>
</div>
</div>
View Git Blame Copy Permalink