Creating a Backend Server Check Task
Function
This API is used to create a task for checking the configurations, network ACL rules, and security group rules of a backend server.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/elb/members/{member_id}/health-check
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
member_id |
Yes |
String |
Definition: Specifies the backend server ID. Constraints: N/A Range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
member_check |
No |
Definition: Specifies the request parameters for creating a backend server check task. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
listener_id |
Yes |
String |
Definition: Specifies the ID of a listener to query the status of the backend servers that are associated with this listener. Range: N/A |
subject |
Yes |
String |
Definition: Specifies the check items. Range:
|
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
member_check |
MemberCheckJob object |
Definition: Specifies the information about the backend server check task. |
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
Example Requests
Creating a backend server check task
POST https://{ELB_Endpoint}/v3/0c1503d710984bad92306faea3654dfd/elb/members/02272819-5655-4c6b-892b-105604f6aea0/health-check { "member_check" : { "listener_id" : "b445cc43-02d7-4863-9481-283b7fb1c222", "subject" : "all" } }
Example Responses
Status code: 201
Successful request.
{ "member_check" : { "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27" }, "request_id" : "9869f52f-b740-4075-bb29-6dd0008a1f1d" }
SDK Sample Code
The SDK sample code is as follows.
Creating a backend server check task
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 |
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.*; public class CreateMemberHealthCheckJobSolution { 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(); CreateMemberHealthCheckJobRequest request = new CreateMemberHealthCheckJobRequest(); request.withMemberId("{member_id}"); CreateMemberHealthCheckJobRequestBody body = new CreateMemberHealthCheckJobRequestBody(); CreateMemberHealthCheckJobOption memberCheckbody = new CreateMemberHealthCheckJobOption(); memberCheckbody.withListenerId("b445cc43-02d7-4863-9481-283b7fb1c222") .withSubject("all"); body.withMemberCheck(memberCheckbody); request.withBody(body); try { CreateMemberHealthCheckJobResponse response = client.createMemberHealthCheckJob(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()); } } } |
Creating a backend server check task
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 |
# 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 = CreateMemberHealthCheckJobRequest() request.member_id = "{member_id}" memberCheckbody = CreateMemberHealthCheckJobOption( listener_id="b445cc43-02d7-4863-9481-283b7fb1c222", subject="all" ) request.body = CreateMemberHealthCheckJobRequestBody( member_check=memberCheckbody ) response = client.create_member_health_check_job(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a backend server check task
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 |
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.CreateMemberHealthCheckJobRequest{} request.MemberId = "{member_id}" memberCheckbody := &model.CreateMemberHealthCheckJobOption{ ListenerId: "b445cc43-02d7-4863-9481-283b7fb1c222", Subject: "all", } request.Body = &model.CreateMemberHealthCheckJobRequestBody{ MemberCheck: memberCheckbody, } response, err := client.CreateMemberHealthCheckJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot