Managed Service for OpenSearch API, gRPC: ClusterService.AddDashboardsNodeGroup
Creates a Dashboards type host group.
gRPC request
rpc AddDashboardsNodeGroup (AddDashboardsNodeGroupRequest) returns (operation.Operation)
AddDashboardsNodeGroupRequest
{
"cluster_id": "string",
"node_group_spec": {
"name": "string",
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"hosts_count": "int64",
"zone_ids": [
"string"
],
"subnet_ids": [
"string"
],
"assign_public_ip": "bool",
"disk_size_autoscaling": {
"planned_usage_threshold": "int64",
"emergency_usage_threshold": "int64",
"disk_size_limit": "int64"
}
}
}
|
Field |
Description |
|
cluster_id |
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. |
|
node_group_spec |
Configuration of the new host group. |
NodeGroup
|
Field |
Description |
|
name |
string Required field. Name of the group. |
|
resources |
Resources allocated to the hosts. |
|
hosts_count |
int64 Number of hosts in the group. |
|
zone_ids[] |
string IDs of the availability zones the hosts belong to. |
|
subnet_ids[] |
string IDs of the subnets that the hosts belong to. |
|
assign_public_ip |
bool Determines whether a public IP is assigned to the hosts in the group. |
|
disk_size_autoscaling |
Disk size autoscaling settings |
Resources
A list of computational resources allocated to a host.
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources allocated to a host. |
|
disk_size |
int64 Volume of the storage used by the host, in bytes. |
|
disk_type_id |
string Type of the storage used by the host: |
DiskSizeAutoscaling
|
Field |
Description |
|
planned_usage_threshold |
int64 Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. |
|
emergency_usage_threshold |
int64 Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. |
|
disk_size_limit |
int64 Limit on how large the storage for database instances can automatically grow, in bytes. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"cluster_id": "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. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
AddNodeGroupMetadata
|
Field |
Description |
|
cluster_id |
string ID of the OpenSearch cluster where the host group is being created. |
|
name |
string Name of the host group being created. |