文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# `DescribeTargetHealth`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeTargetHealth`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [构建和管理弹性服务](elastic-load-balancing-v2_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/ResilientService/ElasticLoadBalancerActions#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Get the target health for a group by name.
///
/// The name of the group.
/// The collection of health descriptions.
public async Task> CheckTargetHealthForGroup(string groupName)
{
List result = null!;
try
{
var groupResponse =
await _amazonElasticLoadBalancingV2.DescribeTargetGroupsAsync(
new DescribeTargetGroupsRequest()
{
Names = new List() { groupName }
});
var healthResponse =
await _amazonElasticLoadBalancingV2.DescribeTargetHealthAsync(
new DescribeTargetHealthRequest()
{
TargetGroupArn = groupResponse.TargetGroups[0].TargetGroupArn
});
;
result = healthResponse.TargetHealthDescriptions;
}
catch (TargetGroupNotFoundException)
{
Console.WriteLine($"Target group {groupName} not found.");
}
return result;
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeTargetHealth](https://docs.aws.amazon.com/goto/DotNetSDKV3/elasticloadbalancingv2-2015-12-01/DescribeTargetHealth)*中的。
------
#### [ CLI ]
**AWS CLI**
**示例 1：描述目标组中目标的运行状况**
以下 `describe-target-health` 示例显示指定目标组中目标的运行状况详细信息。这些目标运行状况良好。
```
aws elbv2 describe-target-health \
--target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
```
输出：
```
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-ceddcd4d",
"Port": 80
},
"TargetHealth": {
"State": "healthy"
}
},
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "healthy"
}
}
]
}
```
**示例 2：描述目标的运行状况**
以下 `describe-target-health` 示例显示指定目标的运行状况详细信息。此目标运行正常。
```
aws elbv2 describe-target-health \
--targets Id=i-0f76fade,Port=80 \
--target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
```
输出：
```
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "healthy"
}
}
]
}
```
以下示例输出适用于未在侦听器的操作中指定目标组的目标。此目标无法接收来自负载均衡器的流量。
```
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "unused",
"Reason": "Target.NotInUse",
"Description": "Target group is not configured to receive traffic from the load balancer"
}
}
]
}
```
以下示例输出适用于仅在侦听器的操作中指定目标组的目标。该目标仍在注册中。
```
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "initial",
"Reason": "Elb.RegistrationInProgress",
"Description": "Target registration is in progress"
}
}
]
}
```
以下示例输出适用于运行状况不佳的目标。
```
{
"TargetHealthDescriptions": [
{
"HealthCheckPort": "80",
"Target": {
"Id": "i-0f76fade",
"Port": 80
},
"TargetHealth": {
"State": "unhealthy",
"Reason": "Target.Timeout",
"Description": "Connection to target timed out"
}
}
]
}
```
以下示例输出针对的目标是 Lambda 函数且运行状况检查已禁用。
```
{
"TargetHealthDescriptions": [
{
"Target": {
"Id": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
"AvailabilityZone": "all",
},
"TargetHealth": {
"State": "unavailable",
"Reason": "Target.HealthCheckDisabled",
"Description": "Health checks are not enabled for this target"
}
}
]
}
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeTargetHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-health.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/resilient_service#code-examples)中查找完整示例，了解如何进行设置和运行。
```
// Checks the health of the instances in the target group.
public List checkTargetHealth(String targetGroupName) {
DescribeTargetGroupsRequest targetGroupsRequest = DescribeTargetGroupsRequest.builder()
.names(targetGroupName)
.build();
DescribeTargetGroupsResponse tgResponse = getLoadBalancerClient().describeTargetGroups(targetGroupsRequest);
DescribeTargetHealthRequest healthRequest = DescribeTargetHealthRequest.builder()
.targetGroupArn(tgResponse.targetGroups().get(0).targetGroupArn())
.build();
DescribeTargetHealthResponse healthResponse = getLoadBalancerClient().describeTargetHealth(healthRequest);
return healthResponse.targetHealthDescriptions();
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeTargetHealth](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticloadbalancingv2-2015-12-01/DescribeTargetHealth)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/wkflw-resilient-service#code-examples)中查找完整示例，了解如何进行设置和运行。
```
const { TargetHealthDescriptions } = await client.send(
new DescribeTargetHealthCommand({
TargetGroupArn: TargetGroups[0].TargetGroupArn,
}),
);
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeTargetHealth](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/elastic-load-balancing-v2/command/DescribeTargetHealthCommand)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例返回指定目标组中存在的目标的运行状况。**
```
Get-ELB2TargetHealth -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**输出**：
```
HealthCheckPort Target TargetHealth
--------------- ------ ------------
80 Amazon.ElasticLoadBalancingV2.Model.TargetDescription Amazon.ElasticLoadBalancingV2.Model.TargetHealth
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例返回指定目标组中存在的目标的运行状况。**
```
Get-ELB2TargetHealth -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**输出**：
```
HealthCheckPort Target TargetHealth
--------------- ------ ------------
80 Amazon.ElasticLoadBalancingV2.Model.TargetDescription Amazon.ElasticLoadBalancingV2.Model.TargetHealth
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/elastic-load-balancing#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ElasticLoadBalancerWrapper:
"""Encapsulates Elastic Load Balancing (ELB) actions."""
def __init__(self, elb_client: boto3.client):
"""
Initializes the LoadBalancer class with the necessary parameters.
"""
self.elb_client = elb_client
def check_target_health(self, target_group_name: str) -> List[Dict[str, Any]]:
"""
Checks the health of the instances in the target group.
:return: The health status of the target group.
"""
try:
tg_response = self.elb_client.describe_target_groups(
Names=[target_group_name]
)
health_response = self.elb_client.describe_target_health(
TargetGroupArn=tg_response["TargetGroups"][0]["TargetGroupArn"]
)
except ClientError as err:
log.error(f"Couldn't check health of {target_group_name} target(s).")
error_code = err.response["Error"]["Code"]
if error_code == "LoadBalancerNotFoundException":
log.error(
"Load balancer associated with the target group was not found. "
"Ensure the load balancer exists, is in the correct AWS region, and "
"that you have the necessary permissions to access it.",
)
elif error_code == "TargetGroupNotFoundException":
log.error(
"Target group was not found. "
"Verify the target group name, check that it exists in the correct region, "
"and ensure it has not been deleted or created in a different account.",
)
log.error(f"Full error:\n\t{err}")
else:
return health_response["TargetHealthDescriptions"]
```
+ 有关 API 的详细信息，请参阅适用[DescribeTargetHealth](https://docs.aws.amazon.com/goto/boto3/elasticloadbalancingv2-2015-12-01/DescribeTargetHealth)于 *Python 的AWS SDK (Boto3) API 参考*。
------