Class LowLevelClusterNamespace

Cluster APIs.

Not intended to be instantiated directly. Use the Cluster property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelClusterNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.ClusterApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelClusterNamespace : NamespacedClientProxy

Methods

AllocationExplainAsync<TResponse>(PostData, ClusterAllocationExplainRequestParameters, CancellationToken)

POST on /_cluster/allocation/explain

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

Declaration

public Task<TResponse> AllocationExplainAsync<TResponse>(PostData body, ClusterAllocationExplainRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The index, shard, and primary flag for which to generate an explanation. Leave this empty to generate an explanation for the first unassigned shard.
ClusterAllocationExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AllocationExplain<TResponse>(PostData, ClusterAllocationExplainRequestParameters)

POST on /_cluster/allocation/explain

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

Declaration

public TResponse AllocationExplain<TResponse>(PostData body, ClusterAllocationExplainRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The index, shard, and primary flag for which to generate an explanation. Leave this empty to generate an explanation for the first unassigned shard.
ClusterAllocationExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ComponentTemplateExistsAsync<TResponse>(string, ComponentTemplateExistsRequestParameters, CancellationToken)

HEAD on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ComponentTemplateExistsAsync<TResponse>(string name, ComponentTemplateExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template. Wildcard (*) expressions are supported.
ComponentTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ComponentTemplateExists<TResponse>(string, ComponentTemplateExistsRequestParameters)

HEAD on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse ComponentTemplateExists<TResponse>(string name, ComponentTemplateExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template. Wildcard (*) expressions are supported.
ComponentTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteComponentTemplateAsync<TResponse>(string, DeleteComponentTemplateRequestParameters, CancellationToken)

DELETE on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> DeleteComponentTemplateAsync<TResponse>(string name, DeleteComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template to delete. Supports wildcard (*) expressions.
DeleteComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteComponentTemplate<TResponse>(string, DeleteComponentTemplateRequestParameters)

DELETE on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse DeleteComponentTemplate<TResponse>(string name, DeleteComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template to delete. Supports wildcard (*) expressions.
DeleteComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteDecommissionAwarenessAsync<TResponse>(DeleteDecommissionAwarenessRequestParameters, CancellationToken)

DELETE on /_cluster/decommission/awareness

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public Task<TResponse> DeleteDecommissionAwarenessAsync<TResponse>(DeleteDecommissionAwarenessRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteDecommissionAwareness<TResponse>(DeleteDecommissionAwarenessRequestParameters)

DELETE on /_cluster/decommission/awareness

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public TResponse DeleteDecommissionAwareness<TResponse>(DeleteDecommissionAwarenessRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteVotingConfigExclusionsAsync<TResponse>(DeleteVotingConfigExclusionsRequestParameters, CancellationToken)

DELETE on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> DeleteVotingConfigExclusionsAsync<TResponse>(DeleteVotingConfigExclusionsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteVotingConfigExclusions<TResponse>(DeleteVotingConfigExclusionsRequestParameters)

DELETE on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public TResponse DeleteVotingConfigExclusions<TResponse>(DeleteVotingConfigExclusionsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteWeightedRoutingAsync<TResponse>(PostData, DeleteWeightedRoutingRequestParameters, CancellationToken)

DELETE on /_cluster/routing/awareness/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights

Declaration

public Task<TResponse> DeleteWeightedRoutingAsync<TResponse>(PostData body, DeleteWeightedRoutingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
DeleteWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteWeightedRouting<TResponse>(PostData, DeleteWeightedRoutingRequestParameters)

DELETE on /_cluster/routing/awareness/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights

Declaration

public TResponse DeleteWeightedRouting<TResponse>(PostData body, DeleteWeightedRoutingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
DeleteWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetComponentTemplateAsync<TResponse>(GetComponentTemplateRequestParameters, CancellationToken)

GET on /_component_template

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetComponentTemplateAsync<TResponse>(GetComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetComponentTemplateAsync<TResponse>(string, GetComponentTemplateRequestParameters, CancellationToken)

GET on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetComponentTemplateAsync<TResponse>(string name, GetComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template to retrieve. Wildcard (<c>*</c>) expressions are supported.
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetComponentTemplate<TResponse>(GetComponentTemplateRequestParameters)

GET on /_component_template

https://opensearch.org/docs/latest

Declaration

public TResponse GetComponentTemplate<TResponse>(GetComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetComponentTemplate<TResponse>(string, GetComponentTemplateRequestParameters)

GET on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse GetComponentTemplate<TResponse>(string name, GetComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template to retrieve. Wildcard (<c>*</c>) expressions are supported.
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetDecommissionAwarenessAsync<TResponse>(string, GetDecommissionAwarenessRequestParameters, CancellationToken)

GET on /_cluster/decommission/awareness/{awareness_attribute_name}/_status

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status

Declaration

public Task<TResponse> GetDecommissionAwarenessAsync<TResponse>(string awarenessAttributeName, GetDecommissionAwarenessRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	The name of the awareness attribute.
GetDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetDecommissionAwareness<TResponse>(string, GetDecommissionAwarenessRequestParameters)

GET on /_cluster/decommission/awareness/{awareness_attribute_name}/_status

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status

Declaration

public TResponse GetDecommissionAwareness<TResponse>(string awarenessAttributeName, GetDecommissionAwarenessRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	The name of the awareness attribute.
GetDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetSettingsAsync<TResponse>(ClusterGetSettingsRequestParameters, CancellationToken)

GET on /_cluster/settings

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

Declaration

public Task<TResponse> GetSettingsAsync<TResponse>(ClusterGetSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterGetSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetSettings<TResponse>(ClusterGetSettingsRequestParameters)

GET on /_cluster/settings

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

Declaration

public TResponse GetSettings<TResponse>(ClusterGetSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterGetSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetWeightedRoutingAsync<TResponse>(string, GetWeightedRoutingRequestParameters, CancellationToken)

GET on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones

Declaration

public Task<TResponse> GetWeightedRoutingAsync<TResponse>(string attribute, GetWeightedRoutingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	The name of the awareness attribute.
GetWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetWeightedRouting<TResponse>(string, GetWeightedRoutingRequestParameters)

GET on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones

Declaration

public TResponse GetWeightedRouting<TResponse>(string attribute, GetWeightedRoutingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	The name of the awareness attribute.
GetWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

HealthAsync<TResponse>(ClusterHealthRequestParameters, CancellationToken)

GET on /_cluster/health

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

Declaration

public Task<TResponse> HealthAsync<TResponse>(ClusterHealthRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

HealthAsync<TResponse>(string, ClusterHealthRequestParameters, CancellationToken)

GET on /_cluster/health/{index}

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

Declaration

public Task<TResponse> HealthAsync<TResponse>(string index, ClusterHealthRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Health<TResponse>(ClusterHealthRequestParameters)

GET on /_cluster/health

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

Declaration

public TResponse Health<TResponse>(ClusterHealthRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Health<TResponse>(string, ClusterHealthRequestParameters)

GET on /_cluster/health/{index}

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

Declaration

public TResponse Health<TResponse>(string index, ClusterHealthRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PendingTasksAsync<TResponse>(ClusterPendingTasksRequestParameters, CancellationToken)

GET on /_cluster/pending_tasks

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> PendingTasksAsync<TResponse>(ClusterPendingTasksRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterPendingTasksRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PendingTasks<TResponse>(ClusterPendingTasksRequestParameters)

GET on /_cluster/pending_tasks

https://opensearch.org/docs/latest

Declaration

public TResponse PendingTasks<TResponse>(ClusterPendingTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterPendingTasksRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PostVotingConfigExclusionsAsync<TResponse>(PostVotingConfigExclusionsRequestParameters, CancellationToken)

POST on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> PostVotingConfigExclusionsAsync<TResponse>(PostVotingConfigExclusionsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PostVotingConfigExclusions<TResponse>(PostVotingConfigExclusionsRequestParameters)

POST on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public TResponse PostVotingConfigExclusions<TResponse>(PostVotingConfigExclusionsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutComponentTemplateAsync<TResponse>(string, PostData, PutComponentTemplateRequestParameters, CancellationToken)

PUT on /_component_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public Task<TResponse> PutComponentTemplateAsync<TResponse>(string name, PostData body, PutComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template to create. OpenSearch includes the following built-in component templates: <c>logs-mappings</c>, <c>logs-settings</c>, <c>metrics-mappings</c>, <c>metrics-settings</c>, <c>synthetics-mapping</c>, and <c>synthetics-settings</c>. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template <c>version</c> to a higher value than the current version. If you want to disable all built-in component and index templates, set <c>stack.templates.enabled</c> to <c>false</c> using the <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/">Cluster Update Settings API</a>.
PostData	body	The template definition.
PutComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutComponentTemplate<TResponse>(string, PostData, PutComponentTemplateRequestParameters)

PUT on /_component_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public TResponse PutComponentTemplate<TResponse>(string name, PostData body, PutComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the component template to create. OpenSearch includes the following built-in component templates: <c>logs-mappings</c>, <c>logs-settings</c>, <c>metrics-mappings</c>, <c>metrics-settings</c>, <c>synthetics-mapping</c>, and <c>synthetics-settings</c>. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template <c>version</c> to a higher value than the current version. If you want to disable all built-in component and index templates, set <c>stack.templates.enabled</c> to <c>false</c> using the <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/">Cluster Update Settings API</a>.
PostData	body	The template definition.
PutComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutDecommissionAwarenessAsync<TResponse>(string, string, PutDecommissionAwarenessRequestParameters, CancellationToken)

PUT on /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public Task<TResponse> PutDecommissionAwarenessAsync<TResponse>(string awarenessAttributeName, string awarenessAttributeValue, PutDecommissionAwarenessRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	The name of the awareness attribute.
string	awarenessAttributeValue	The value of the awareness attribute. For example, if you have shards allocated in two different zones, you can give each zone a value of <c>zone-a</c> or <c>zoneb</c>. The cluster decommission operation decommissions the zone listed in the method.
PutDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutDecommissionAwareness<TResponse>(string, string, PutDecommissionAwarenessRequestParameters)

PUT on /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public TResponse PutDecommissionAwareness<TResponse>(string awarenessAttributeName, string awarenessAttributeValue, PutDecommissionAwarenessRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	The name of the awareness attribute.
string	awarenessAttributeValue	The value of the awareness attribute. For example, if you have shards allocated in two different zones, you can give each zone a value of <c>zone-a</c> or <c>zoneb</c>. The cluster decommission operation decommissions the zone listed in the method.
PutDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutSettingsAsync<TResponse>(PostData, ClusterPutSettingsRequestParameters, CancellationToken)

PUT on /_cluster/settings

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

Declaration

public Task<TResponse> PutSettingsAsync<TResponse>(PostData body, ClusterPutSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The cluster settings to update.
ClusterPutSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutSettings<TResponse>(PostData, ClusterPutSettingsRequestParameters)

PUT on /_cluster/settings

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

Declaration

public TResponse PutSettings<TResponse>(PostData body, ClusterPutSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The cluster settings to update.
ClusterPutSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutWeightedRoutingAsync<TResponse>(string, PostData, PutWeightedRoutingRequestParameters, CancellationToken)

PUT on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search

Declaration

public Task<TResponse> PutWeightedRoutingAsync<TResponse>(string attribute, PostData body, PutWeightedRoutingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	The name of awareness attribute, usually <c>zone</c>.
PostData	body
PutWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutWeightedRouting<TResponse>(string, PostData, PutWeightedRoutingRequestParameters)

PUT on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search

Declaration

public TResponse PutWeightedRouting<TResponse>(string attribute, PostData body, PutWeightedRoutingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	The name of awareness attribute, usually <c>zone</c>.
PostData	body
PutWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RemoteInfoAsync<TResponse>(RemoteInfoRequestParameters, CancellationToken)

GET on /_remote/info

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public Task<TResponse> RemoteInfoAsync<TResponse>(RemoteInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RemoteInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RemoteInfo<TResponse>(RemoteInfoRequestParameters)

GET on /_remote/info

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public TResponse RemoteInfo<TResponse>(RemoteInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RemoteInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RerouteAsync<TResponse>(PostData, ClusterRerouteRequestParameters, CancellationToken)

POST on /_cluster/reroute

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> RerouteAsync<TResponse>(PostData body, ClusterRerouteRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The definition of <c>commands</c> to perform (<c>move</c>, <c>cancel</c>, <c>allocate</c>).
ClusterRerouteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Reroute<TResponse>(PostData, ClusterRerouteRequestParameters)

POST on /_cluster/reroute

https://opensearch.org/docs/latest

Declaration

public TResponse Reroute<TResponse>(PostData body, ClusterRerouteRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The definition of <c>commands</c> to perform (<c>move</c>, <c>cancel</c>, <c>allocate</c>).
ClusterRerouteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

StateAsync<TResponse>(ClusterStateRequestParameters, CancellationToken)

GET on /_cluster/state

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StateAsync<TResponse>(ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StateAsync<TResponse>(string, ClusterStateRequestParameters, CancellationToken)

GET on /_cluster/state/{metric}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StateAsync<TResponse>(string metric, ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limits the information returned to only the <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#metric-groups">specified metric groups</a>.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StateAsync<TResponse>(string, string, ClusterStateRequestParameters, CancellationToken)

GET on /_cluster/state/{metric}/{index}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StateAsync<TResponse>(string metric, string index, ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limits the information returned to only the <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#metric-groups">specified metric groups</a>.
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

State<TResponse>(ClusterStateRequestParameters)

GET on /_cluster/state

https://opensearch.org/docs/latest

Declaration

public TResponse State<TResponse>(ClusterStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

State<TResponse>(string, ClusterStateRequestParameters)

GET on /_cluster/state/{metric}

https://opensearch.org/docs/latest

Declaration

public TResponse State<TResponse>(string metric, ClusterStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limits the information returned to only the <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#metric-groups">specified metric groups</a>.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

State<TResponse>(string, string, ClusterStateRequestParameters)

GET on /_cluster/state/{metric}/{index}

https://opensearch.org/docs/latest

Declaration

public TResponse State<TResponse>(string metric, string index, ClusterStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limits the information returned to only the <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#metric-groups">specified metric groups</a>.
string	index	A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (<c></c>). To target all data streams and indexes, omit this parameter or use <c></c> or <c>_all</c>.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

StatsAsync<TResponse>(ClusterStatsRequestParameters, CancellationToken)

GET on /_cluster/stats

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

Declaration

public Task<TResponse> StatsAsync<TResponse>(ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StatsAsync<TResponse>(string, ClusterStatsRequestParameters, CancellationToken)

GET on /_cluster/stats/nodes/{node_id}

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

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs used to filter results. Supports <a href="https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters">node filters</a>.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StatsAsync<TResponse>(string, string, ClusterStatsRequestParameters, CancellationToken)

GET on /_cluster/stats/{metric}/nodes/{node_id}

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

Declaration

public Task<TResponse> StatsAsync<TResponse>(string metric, string nodeId, ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
string	nodeId	A comma-separated list of node IDs used to filter results. Supports <a href="https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters">node filters</a>.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

StatsAsync<TResponse>(string, string, string, ClusterStatsRequestParameters, CancellationToken)

GET on /_cluster/stats/{metric}/{index_metric}/nodes/{node_id}

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

Declaration

public Task<TResponse> StatsAsync<TResponse>(string metric, string indexMetric, string nodeId, ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
string	indexMetric	A comma-separated list of <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#index-metric-groups">index metric groups</a>, for example, <c>docs,store</c>.
string	nodeId	A comma-separated list of node IDs used to filter results. Supports <a href="https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters">node filters</a>.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Stats<TResponse>(ClusterStatsRequestParameters)

GET on /_cluster/stats

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

Declaration

public TResponse Stats<TResponse>(ClusterStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Stats<TResponse>(string, ClusterStatsRequestParameters)

GET on /_cluster/stats/nodes/{node_id}

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

Declaration

public TResponse Stats<TResponse>(string nodeId, ClusterStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs used to filter results. Supports <a href="https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters">node filters</a>.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Stats<TResponse>(string, string, ClusterStatsRequestParameters)

GET on /_cluster/stats/{metric}/nodes/{node_id}

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

Declaration

public TResponse Stats<TResponse>(string metric, string nodeId, ClusterStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
string	nodeId	A comma-separated list of node IDs used to filter results. Supports <a href="https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters">node filters</a>.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Stats<TResponse>(string, string, string, ClusterStatsRequestParameters)

GET on /_cluster/stats/{metric}/{index_metric}/nodes/{node_id}

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

Declaration

public TResponse Stats<TResponse>(string metric, string indexMetric, string nodeId, ClusterStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
string	indexMetric	A comma-separated list of <a href="https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#index-metric-groups">index metric groups</a>, for example, <c>docs,store</c>.
string	nodeId	A comma-separated list of node IDs used to filter results. Supports <a href="https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters">node filters</a>.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.18.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)