查询后端服务器检测任务的结果
功能介绍
查询后端服务器检测任务的结果。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/members/check/jobs/{job_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。获取方式请参见获取项目ID。 约束限制:不涉及 取值范围:长度为32个字符,由小写字母和数字组成。 默认取值:不涉及 |
job_id |
是 |
String |
参数解释:创建后端服务器检测任务的接口返回的job_id。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
member_check |
MemberCheckJobInfo object |
参数解释:后端服务器检测任务结果。 |
request_id |
String |
参数解释:请求ID。 取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。 |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释:processed检查完成,processing检查中,failed检查失败。 取值范围:不涉及 |
result |
MemberCheckJobResult object |
参数解释:后端服务器检测任务各检查项的检测结果。 |
created_at |
String |
参数解释:任务创建时间。 取值范围:不涉及 |
updated_at |
String |
参数解释:任务更新时间。 取值范围:不涉及 |
job_id |
String |
参数解释:任务ID。 |
check_item_total_num |
Integer |
参数解释:检查项总个数。 取值范围:不涉及 |
check_item_finished_num |
Integer |
参数解释:已检查完成的检查项个数。 取值范围:不涉及 |
listener_id |
String |
参数解释:后端服务器所关联的监听器,查询在该监听器下后端服务器的状态。 取值范围:不涉及 |
member_id |
String |
参数解释:后端服务器ID。 取值范围:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
config |
MemberCheckJobResultGroup object |
参数解释:配置检查。 取值范围:不涉及 |
acl |
MemberCheckJobResultGroup object |
参数解释:ACL规则检查。 取值范围:不涉及 |
security_group |
MemberCheckJobResultGroup object |
参数解释:安全组规则检查。 取值范围:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
check_result |
Boolean |
参数解释:检查结果,true表示检查通过,false为检查不通过。 取值范围:不涉及 |
check_items |
Array of MemberCheckJobResultItem objects |
参数解释:分组检查项汇总。 |
check_status |
String |
参数解释:processed检查完成,processing检查中,failed检查失败。 取值范围:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:检查项名称。 取值范围:不涉及 |
reason |
String |
参数解释:异常原因。 取值范围:不涉及 |
severity |
String |
参数解释:重要级别,分为Major(严重)和Tips(提示)。 取值范围:不涉及 |
subject |
String |
参数解释:检查类别,config表示配置检查。 取值范围:不涉及 |
job_id |
String |
参数解释:任务ID。 取值范围:不涉及 |
reason_template |
String |
参数解释:异常原因模板。 取值范围:不涉及 |
reason_params |
Array of strings |
参数解释:异常结果变量参数表,用于结合异常原因模板动态生成异常原因。 取值范围:不涉及 |
请求示例
查询后端服务器检测任务的结果
POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/members/check/jobs/04a9bc65-b75b-478d-b4d6-e693bb61dd35
响应示例
状态码:200
操作正常返回。
{ "member_check" : { "status" : "processed", "result" : { "config" : { "check_result" : true, "check_items" : [ { "name" : "check_hc_config_port", "reason" : null, "severity" : "Tips", "subject" : "config", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck {$hm_id}'s protocolPort {$protocol_port} is different from member port {$member_port}", "reason_params" : [ ] } ], "check_status" : "processed" }, "acl" : { "check_result" : true, "check_items" : [ { "name" : "acl_check_hc_protocol_egress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck {$hm_id}'s protocol is {$hc_protocol}, but the transport layer protocol corresponding to the protocol {$trans_protocol} is not allowed by ACL {$acl_id} egress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_dest_port_egress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck destination port may not allowed by ACL {$acl_id} egress policies, it is recommended to open all destination ports", "reason_params" : [ ] }, { "name" : "acl_check_hc_dest_ip_egress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck destination IP {$dest_ip} is not allowed by ACL {$acl_id} egress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_source_port_egress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck source port {$source_port} is not allowed by ACL {$acl_id} egress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_source_ip_egress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck source IP {$source_ip} is not allowed by ACL {$acl_id} egress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_protocol_ingress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck {$hm_id}'s protocol is {$hc_protocol}, but the transport layer protocol corresponding to the protocol {$trans_protocol} is not allowed by ACL {$acl_id} ingress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_dest_port_ingress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck destination port {$dest_port} is not allowed by ACL {$acl_id} ingress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_dest_ip_ingress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck destination IP {$dest_ip} is not allowed by ACL {$acl_id} ingress policies", "reason_params" : [ ] }, { "name" : "acl_check_hc_source_port_ingress", "reason" : null, "severity" : "Tips", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck source port may not allowed by ACL {$acl_id} ingress policies, it is recommended to open all destination ports", "reason_params" : [ ] }, { "name" : "acl_check_hc_source_ip_ingress", "reason" : null, "severity" : "Major", "subject" : "networkAcl", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck source IP {$source_ip} is not allowed by ACL {$acl_id} ingress policies", "reason_params" : [ ] } ], "check_status" : "processed" }, "security_group" : { "check_result" : true, "check_items" : [ { "name" : "security_group_check_hc_protocol_egress", "reason" : null, "severity" : "Major", "subject" : "securityGroup", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck {$hm_id}'s protocol is {$hc_protocol}, but the transport layer protocol corresponding to the protocol {$transport_protocol} is not allowed by securityGroup {$security_group_id} egress rules", "reason_params" : [ ] }, { "name" : "security_group_check_hc_port_egress", "reason" : null, "severity" : "Major", "subject" : "securityGroup", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck dest port {$dest_port} is not allowed by securityGroup {$security_group_id} egress rules", "reason_params" : [ ] }, { "name" : "security_group_check_hc_source_ip_egress", "reason" : null, "severity" : "Major", "subject" : "securityGroup", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck source IP {$source_ip} is not allowed by securityGroup {$security_group_id} egress rules", "reason_params" : [ ] }, { "name" : "security_group_check_hc_protocol_ingress", "reason" : null, "severity" : "Major", "subject" : "securityGroup", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck {$hm_id}'s protocol is {$hc_protocol}, but the transport layer protocol corresponding to the protocol {$transport_protocol} is not allowed by securityGroup {$security_group_id} ingress rules", "reason_params" : [ ] }, { "name" : "security_group_check_hc_port_ingress", "reason" : null, "severity" : "Major", "subject" : "securityGroup", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck dest port {$dest_port} is not allowed by securityGroup {$security_group_id} ingress rules", "reason_params" : [ ] }, { "name" : "security_group_check_hc_source_ip_ingress", "reason" : null, "severity" : "Major", "subject" : "securityGroup", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "reason_template" : "healthCheck source IP {$source_ip} is not allowed by securityGroup {$security_group_id} ingress rules", "reason_params" : [ ] } ], "check_status" : "processed" } }, "created_at" : "2024-12-08T07:55:04Z", "updated_at" : "2024-12-08T07:55:05Z", "job_id" : "919221ce-0011-4558-81ca-2866e6e68a27", "check_item_total_num" : 17, "check_item_finished_num" : 17, "listener_id" : "b445cc43-02d7-4863-9481-283b7fb1c222", "member_id" : "02272819-5655-4c6b-892b-105604f6aea0" }, "request_id" : "5980e624-dc64-46b9-8d74-e5834655dab5" }
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 |
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 ShowMemberHealthCheckJobSolution { 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(); ShowMemberHealthCheckJobRequest request = new ShowMemberHealthCheckJobRequest(); request.withJobId("{job_id}"); try { ShowMemberHealthCheckJobResponse response = client.showMemberHealthCheckJob(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 |
# 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 = ShowMemberHealthCheckJobRequest() request.job_id = "{job_id}" response = client.show_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) |
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 |
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.ShowMemberHealthCheckJobRequest{} request.JobId = "{job_id}" response, err := client.ShowMemberHealthCheckJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。