Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS SDK または CLI `DescribeTargetHealth`で を使用する
次のサンプルコードは、`DescribeTargetHealth` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [レジリエントなサービスの構築と管理](elastic-load-balancing-v2_example_cross_ResilientService_section.md)
+ [Elastic Load Balancing の使用開始](elastic-load-balancing-v2_example_elastic_load_balancing_v2_GettingStarted_058_section.md)
------
#### [ .NET ]
**SDK for .NET**
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 の詳細については、「*AWS SDK for .NET 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 ]
**SDK for Java 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 ]
**SDK for 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 の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[DescribeTargetHealth](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/elastic-load-balancing-v2/command/DescribeTargetHealthCommand)」を参照してください。
------
#### [ PowerShell ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
#### [ Python ]
**SDK for Python (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 の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DescribeTargetHealth](https://docs.aws.amazon.com/goto/boto3/elasticloadbalancingv2-2015-12-01/DescribeTargetHealth)」を参照してください。
------