文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# `DescribeClusters`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DescribeClusters`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [了解基本功能](redshift_example_redshift_Scenario_section.md)
------
#### [ .NET ]
**适用于 .NET 的 SDK (v4)**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/Redshift#code-examples)中查找完整示例，了解如何进行设置和运行。
```
///
/// Describe Amazon Redshift clusters.
///
/// Optional cluster identifier to describe a specific cluster.
/// A list of clusters.
public async Task> DescribeClustersAsync(string? clusterIdentifier = null)
{
try
{
var clusters = new List();
var request = new DescribeClustersRequest();
if (!string.IsNullOrEmpty(clusterIdentifier))
{
request.ClusterIdentifier = clusterIdentifier;
}
var clustersPaginator = _redshiftClient.Paginators.DescribeClusters(request);
await foreach (var response in clustersPaginator.Responses)
{
if (response.Clusters != null)
clusters.AddRange(response.Clusters);
}
Console.WriteLine($"{clusters.Count} cluster(s) retrieved.");
foreach (var cluster in clusters)
{
Console.WriteLine($"\t{cluster.ClusterIdentifier} (Status: {cluster.ClusterStatus})");
}
return clusters;
}
catch (ClusterNotFoundException ex)
{
Console.WriteLine($"Cluster {clusterIdentifier} not found: {ex.Message}");
throw;
}
catch (Exception ex)
{
Console.WriteLine($"Couldn't describe clusters. Here's why: {ex.Message}");
throw;
}
}
```
+ 有关 API 的详细信息，请参阅 *适用于 .NET 的 AWS SDK API 参考[DescribeClusters](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-2012-12-01/DescribeClusters)*中的。
------
#### [ CLI ]
**AWS CLI**
获取全部描述 ClustersThis 示例返回该账户所有集群的描述。默认情况下，输出采用 JSON 格式。命令：
```
aws redshift describe-clusters
```
结果：
```
{
"Clusters": [
{
"NodeType": "dw.hs1.xlarge",
"Endpoint": {
"Port": 5439,
"Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com"
},
"ClusterVersion": "1.0",
"PubliclyAccessible": "true",
"MasterUsername": "adminuser",
"ClusterParameterGroups": [
{
"ParameterApplyStatus": "in-sync",
"ParameterGroupName": "default.redshift-1.0"
} ],
"ClusterSecurityGroups": [
{
"Status": "active",
"ClusterSecurityGroupName": "default"
} ],
"AllowVersionUpgrade": true,
"VpcSecurityGroups": \[],
"AvailabilityZone": "us-east-1a",
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"PreferredMaintenanceWindow": "sat:03:30-sat:04:00",
"AutomatedSnapshotRetentionPeriod": 1,
"ClusterStatus": "available",
"ClusterIdentifier": "mycluster",
"DBName": "dev",
"NumberOfNodes": 2,
"PendingModifiedValues": {}
} ],
"ResponseMetadata": {
"RequestId": "65b71cac-64df-11e2-8f5b-e90bd6c77476"
}
}
```
您也可以使用 `--output text` 选项以文本格式获取相同的信息。命令：
`--output text` 选项。命令：
选项。命令：
```
aws redshift describe-clusters --output text
```
结果：
```
dw.hs1.xlarge 1.0 true adminuser True us-east-1a 2013-01-22T21:59:29.559Z sat:03:30-sat:04:00 1 available mycluster dev 2
ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com
in-sync default.redshift-1.0
active default
PENDINGMODIFIEDVALUES
RESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-clusters.html)*中的。
------
#### [ Go ]
**适用于 Go 的 SDK V2**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/redshift#code-examples)中查找完整示例，了解如何进行设置和运行。
```
import (
"context"
"errors"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/redshift"
"github.com/aws/aws-sdk-go-v2/service/redshift/types"
)
// RedshiftActions wraps Redshift service actions.
type RedshiftActions struct {
RedshiftClient *redshift.Client
}
// DescribeClusters returns information about the given cluster.
func (actor RedshiftActions) DescribeClusters(ctx context.Context, clusterId string) (*redshift.DescribeClustersOutput, error) {
input, err := actor.RedshiftClient.DescribeClusters(ctx, &redshift.DescribeClustersInput{
ClusterIdentifier: aws.String(clusterId),
})
var opErr *types.AccessToClusterDeniedFault
if errors.As(err, &opErr) {
println("Access to cluster denied.")
panic(err)
} else if err != nil {
println("Failed to describe Redshift clusters.")
return nil, err
}
return input, nil
}
```
+ 有关 API 的详细信息，请参阅 *适用于 Go 的 AWS SDK API 参考[DescribeClusters](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/redshift#Client.DescribeClusters)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/redshift#code-examples)中查找完整示例，了解如何进行设置和运行。
描述集群。
```
/**
* Waits asynchronously for the specified cluster to become available.
* @param clusterId the identifier of the cluster to wait for
* @return a {@link CompletableFuture} that completes when the cluster is ready
*/
public CompletableFuture waitForClusterReadyAsync(String clusterId) {
DescribeClustersRequest clustersRequest = DescribeClustersRequest.builder()
.clusterIdentifier(clusterId)
.build();
logger.info("Waiting for cluster to become available. This may take a few minutes.");
long startTime = System.currentTimeMillis();
// Recursive method to poll the cluster status.
return checkClusterStatusAsync(clustersRequest, startTime);
}
private CompletableFuture checkClusterStatusAsync(DescribeClustersRequest clustersRequest, long startTime) {
return getAsyncClient().describeClusters(clustersRequest)
.thenCompose(clusterResponse -> {
List clusterList = clusterResponse.clusters();
boolean clusterReady = false;
for (Cluster cluster : clusterList) {
if ("available".equals(cluster.clusterStatus())) {
clusterReady = true;
break;
}
}
if (clusterReady) {
logger.info(String.format("Cluster is available!"));
return CompletableFuture.completedFuture(null);
} else {
long elapsedTimeMillis = System.currentTimeMillis() - startTime;
long elapsedSeconds = elapsedTimeMillis / 1000;
long minutes = elapsedSeconds / 60;
long seconds = elapsedSeconds % 60;
System.out.printf("\rElapsed Time: %02d:%02d - Waiting for cluster...", minutes, seconds);
System.out.flush();
// Wait 1 second before the next status check
return CompletableFuture.runAsync(() -> {
try {
TimeUnit.SECONDS.sleep(1);
} catch (InterruptedException e) {
throw new RuntimeException("Error during sleep: " + e.getMessage(), e);
}
}).thenCompose(ignored -> checkClusterStatusAsync(clustersRequest, startTime));
}
}).exceptionally(exception -> {
throw new RuntimeException("Failed to get cluster status: " + exception.getMessage(), exception);
});
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DescribeClusters](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-2012-12-01/DescribeClusters)*中的。
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/redshift#code-examples)中查找完整示例，了解如何进行设置和运行。
创建客户端。
```
import { RedshiftClient } from "@aws-sdk/client-redshift";
// Set the AWS Region.
const REGION = "REGION";
//Set the Redshift Service Object
const redshiftClient = new RedshiftClient({ region: REGION });
export { redshiftClient };
```
描述集群。
```
// Import required AWS SDK clients and commands for Node.js
import { DescribeClustersCommand } from "@aws-sdk/client-redshift";
import { redshiftClient } from "./libs/redshiftClient.js";
const params = {
ClusterIdentifier: "CLUSTER_NAME",
};
const run = async () => {
try {
const data = await redshiftClient.send(new DescribeClustersCommand(params));
console.log("Success", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ 有关 API 的详细信息，请参阅 *适用于 JavaScript 的 AWS SDK API 参考[DescribeClusters](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/redshift/command/DescribeClustersCommand)*中的。
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/redshift#code-examples)中查找完整示例，了解如何进行设置和运行。
描述集群。
```
suspend fun describeRedshiftClusters() {
RedshiftClient.fromEnvironment { region = "us-west-2" }.use { redshiftClient ->
val clusterResponse = redshiftClient.describeClusters(DescribeClustersRequest {})
val clusterList = clusterResponse.clusters
if (clusterList != null) {
for (cluster in clusterList) {
println("Cluster database name is ${cluster.dbName}")
println("Cluster status is ${cluster.clusterStatus}")
}
}
}
}
```
+ 有关 API 的详细信息，请参阅适用[DescribeClusters](https://sdk.amazonaws.com/kotlin/api/latest/index.html)于 K *otlin 的AWS SDK API 参考*。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/redshift#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class RedshiftWrapper:
"""
Encapsulates Amazon Redshift cluster operations.
"""
def __init__(self, redshift_client):
"""
:param redshift_client: A Boto3 Redshift client.
"""
self.client = redshift_client
def describe_clusters(self, cluster_identifier):
"""
Describes a cluster.
:param cluster_identifier: The cluster identifier.
:return: A list of clusters.
"""
try:
kwargs = {}
if cluster_identifier:
kwargs["ClusterIdentifier"] = cluster_identifier
paginator = self.client.get_paginator("describe_clusters")
clusters = []
for page in paginator.paginate(**kwargs):
clusters.extend(page["Clusters"])
return clusters
except ClientError as err:
logging.error(
"Couldn't describe a cluster. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
以下代码实例化对象。 RedshiftWrapper
```
client = boto3.client("redshift")
redhift_wrapper = RedshiftWrapper(client)
```
+ 有关 API 的详细信息，请参阅适用[DescribeClusters](https://docs.aws.amazon.com/goto/boto3/redshift-2012-12-01/DescribeClusters)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/rsh#code-examples)中查找完整示例，了解如何进行设置和运行。
描述集群。
```
TRY.
" Example values: iv_cluster_identifier = 'my-redshift-cluster' (optional)
oo_result = lo_rsh->describeclusters(
iv_clusteridentifier = iv_cluster_identifier
).
lt_clusters = oo_result->get_clusters( ).
lv_cluster_count = lines( lt_clusters ).
MESSAGE |Retrieved { lv_cluster_count } cluster(s).| TYPE 'I'.
CATCH /aws1/cx_rshclustnotfoundfault.
MESSAGE 'Cluster not found.' TYPE 'I'.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[DescribeClusters](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------