Class ClusterHealthRequest

Request for Health

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

Inheritance
object
RequestBase<ClusterHealthRequestParameters>
PlainRequestBase<ClusterHealthRequestParameters>
ClusterHealthRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterHealthRequest : PlainRequestBase<ClusterHealthRequestParameters>, IClusterHealthRequest, IRequest<ClusterHealthRequestParameters>, IRequest

Constructors

| Edit this page View Source

ClusterHealthRequest()

/_cluster/health

Declaration
public ClusterHealthRequest()
| Edit this page View Source

ClusterHealthRequest(Indices)

/_cluster/health/{index}

Declaration
public ClusterHealthRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

AwarenessAttribute

The name of the awareness attribute for which to return the cluster health status (for example, zone). Applicable only if level is set to awareness_attributes.

Declaration
public string AwarenessAttribute { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ClusterManagerTimeout

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

Level

Controls the amount of detail included in the cluster health response.

Declaration
public ClusterHealthLevel? Level { get; set; }
Property Value
Type Description
ClusterHealthLevel?
| Edit this page View Source

Local

Whether to return information from the local node only instead of from the cluster manager node.

Declaration
public bool? Local { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MasterTimeout

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IClusterHealthRequest Self { get; }
Property Value
Type Description
IClusterHealthRequest
| Edit this page View Source

Timeout

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

WaitForActiveShards

Waits until the specified number of shards is active before returning a response. Use all for all shards.

Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type Description
string
| Edit this page View Source

WaitForEvents

Waits until all currently queued events with the given priority are processed.

Declaration
public WaitForEvents? WaitForEvents { get; set; }
Property Value
Type Description
WaitForEvents?
| Edit this page View Source

WaitForNoInitializingShards

Whether to wait until there are no initializing shards in the cluster.

Declaration
public bool? WaitForNoInitializingShards { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

WaitForNoRelocatingShards

Whether to wait until there are no relocating shards in the cluster.

Declaration
public bool? WaitForNoRelocatingShards { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

WaitForNodes

Waits until the specified number of nodes (N) is available. Accepts >=N, <=N, >N, and <N. You can also use ge(N), le(N), gt(N), and lt(N) notation.

Declaration
public string WaitForNodes { get; set; }
Property Value
Type Description
string
| Edit this page View Source

WaitForStatus

Waits until the cluster health reaches the specified status or better.

Declaration
public HealthStatus? WaitForStatus { get; set; }
Property Value
Type Description
HealthStatus?

Implements

Extension Methods