Contact UsGet started

Managed Service for OpenSearch API, gRPC: ClusterService.AddDashboardsNodeGroup

Written by
Updated at October 17, 2024

Creates a Dashboards type host group.

gRPC request

rpc AddDashboardsNodeGroup (AddDashboardsNodeGroupRequest) returns (operation.Operation)

AddDashboardsNodeGroupRequest

{
  "clusterId": "string",
  "nodeGroupSpec": {
    "name": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "int64",
      "diskTypeId": "string"
    },
    "hostsCount": "int64",
    "zoneIds": [
      "string"
    ],
    "subnetIds": [
      "string"
    ],
    "assignPublicIp": "bool",
    "diskSizeAutoscaling": {
      "plannedUsageThreshold": "int64",
      "emergencyUsageThreshold": "int64",
      "diskSizeLimit": "int64"
    }
  }
}

Field

Description

clusterId

string

Required field. ID of the OpenSearch cluster to create the Dashboards type host group in.

To get the ID, use a ClusterService.List request.

nodeGroupSpec

NodeGroup

Configuration of the new host group.

NodeGroup

Field

Description

name

string

Required field. Name of the group.

resources

Resources

Resources allocated to the hosts.

hostsCount

int64

Number of hosts in the group.

zoneIds[]

string

IDs of the availability zones the hosts belong to.

subnetIds[]

string

IDs of the subnets that the hosts belong to.

assignPublicIp

bool

Determines whether a public IP is assigned to the hosts in the group.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

Resources

A list of computational resources allocated to a host.

Field

Description

resourcePresetId

string

ID of the preset for computational resources allocated to a host.

diskSize

int64

Volume of the storage used by the host, in bytes.

diskTypeId

string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

DiskSizeAutoscaling

Field

Description

plannedUsageThreshold

int64

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold

int64

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit

int64

Limit on how large the storage for database instances can automatically grow, in bytes.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

AddNodeGroupMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

AddNodeGroupMetadata

Field

Description

clusterId

string

ID of the OpenSearch cluster where the host group is being created.

name

string

Name of the host group being created.
Previous
UpdateOpenSearchNodeGroup
Next
DeleteDashboardsNodeGroup