Managed Service for OpenSearch API, gRPC: ClusterService
- Calls ClusterService
- Get
- List
- Create
- Update
- Delete
- Backup
- Restore
- RescheduleMaintenance
- ListBackups
- Move
- Start
- Stop
- ListLogs
- StreamLogs
- ListOperations
- ListHosts
- AddOpenSearchNodeGroup
- DeleteOpenSearchNodeGroup
- UpdateOpenSearchNodeGroup
- AddDashboardsNodeGroup
- DeleteDashboardsNodeGroup
- UpdateDashboardsNodeGroup
- GetAuthSettings
- UpdateAuthSettings
A set of methods for managing OpenSearch clusters.
Call | Description |
---|---|
Get | Returns the specified OpenSearch cluster. |
List | Retrieves the list of OpenSearch clusters that belong to the specified folder. |
Create | Creates an OpenSearch cluster in the specified folder. |
Update | Updates the specified OpenSearch cluster. |
Delete | Deletes the specified OpenSearch cluster. |
Backup | Creates a backup for the specified OpenSearch cluster. |
Restore | Creates a new OpenSearch cluster using the specified backup. |
RescheduleMaintenance | Reschedules a planned maintenance operation. |
ListBackups | Returns a list of available backups for the specified OpenSearch cluster. |
Move | Moves the specified OpenSearch cluster to the specified folder. |
Start | Starts the specified OpenSearch cluster. |
Stop | Stops the specified OpenSearch cluster. |
ListLogs | Retrieves logs for the specified OpenSearch cluster. |
StreamLogs | Same as ListLogs but using server-side streaming. |
ListOperations | Retrieves the list of Operation resources for the specified cluster. |
ListHosts | Retrieves a list of hosts for the specified cluster. |
AddOpenSearchNodeGroup | Creates an OpenSearch type host group. |
DeleteOpenSearchNodeGroup | Deletes an OpenSearch type host group. |
UpdateOpenSearchNodeGroup | Updates an OpenSearch type host group. |
AddDashboardsNodeGroup | Creates a Dashboards type host group. |
DeleteDashboardsNodeGroup | Deletes a Dashboards type host group. |
UpdateDashboardsNodeGroup | Updates a Dashboards type host group. |
GetAuthSettings | Retrieves auth settings for specified cluster. |
UpdateAuthSettings | Updates auth settings for specified cluster. |
Calls ClusterService
Get
Returns the specified OpenSearch cluster.
To get the list of all available OpenSearch clusters, make a List request.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to return. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
List
Retrieves the list of OpenSearch clusters that belong to the specified folder.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list OpenSearch clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
|
ListClustersResponse
Field | Description |
---|---|
clusters[] | Cluster List of OpenSearch clusters. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
Create
Creates an OpenSearch cluster in the specified folder.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create the OpenSearch cluster in. The maximum string length in characters is 50. |
name | string Required. Name of the OpenSearch cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the OpenSearch cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. For example, "project": "mvp" or "source": "dictionary" . No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Deployment environment of the OpenSearch cluster. |
config_spec | ConfigCreateSpec Required. OpenSearch cluster configuration. |
network_id | string Required. ID of the network to create the cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
ConfigCreateSpec
Field | Description |
---|---|
version | string OpenSearch version. |
admin_password | string Required. OpenSearch admin password. |
opensearch_spec | OpenSearchCreateSpec OpenSearch configuration. |
dashboards_spec | DashboardsCreateSpec Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearchCreateSpec
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup OpenSearch type host groups of the cluster. |
config | oneof: opensearch_config_2 |
opensearch_config_2 | config.OpenSearchConfig2 |
NodeGroup
Field | Description |
---|---|
name | string Required. Name of the group. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
resources | Resources Resources allocated to the hosts. |
hosts_count | int64 Number of hosts in the group. The minimum value is 1. |
zone_ids[] | string IDs of the availability zones the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
subnet_ids[] | string IDs of the subnets that the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
assign_public_ip | bool Determines whether a public IP is assigned to the hosts in the group. |
roles[] | OpenSearch.GroupRole Roles of the hosts in the group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
DashboardsCreateSpec
Field | Description |
---|---|
node_groups[] | NodeGroup Dashboards type host groups of the cluster. |
NodeGroup
Field | Description |
---|---|
name | string Required. Name of the group. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
resources | Resources Resources allocated to the hosts. |
hosts_count | int64 Number of hosts in the group. The minimum value is 1. |
zone_ids[] | string IDs of the availability zones the hosts belong to. |
subnet_ids[] | string IDs of the subnets that the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
assign_public_ip | bool Determines whether a public IP is assigned to the hosts in the group. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster that is being created. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
Update
Updates the specified OpenSearch cluster.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster resource to update. To get the OpenSearch cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the OpenSearch cluster resource should be updated. |
description | string New description of the OpenSearch cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. For example, "project": "mvp" or "source": "dictionary" . The new set of labels completely replaces the old one. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
config_spec | ConfigUpdateSpec New cluster configuration |
name | string New name for the cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
ConfigUpdateSpec
Field | Description |
---|---|
version | string OpenSearch version. |
admin_password | string Required. OpenSearch admin password. |
opensearch_spec | OpenSearchClusterUpdateSpec OpenSearch configuration. |
dashboards_spec | DashboardsClusterUpdateSpec Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearchClusterUpdateSpec
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
config | oneof: opensearch_config_2 |
opensearch_config_2 | config.OpenSearchConfig2 |
DashboardsClusterUpdateSpec
Empty.
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster resource that is being updated. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
Delete
Deletes the specified OpenSearch cluster.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to delete. To get the OpenSearch cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster that is being deleted. |
Backup
Creates a backup for the specified OpenSearch cluster.
rpc Backup (BackupClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:BackupClusterMetadata
Operation.response:Cluster
BackupClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to back up. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
BackupClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster being backed up. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
Restore
Creates a new OpenSearch cluster using the specified backup.
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RestoreClusterMetadata
Operation.response:Cluster
RestoreClusterRequest
Field | Description |
---|---|
backup_id | string Required. ID of the backup to create a new cluster from. To get the backup ID, use a ClusterService.ListBackups request. |
name | string Required. Name of the new OpenSearch cluster to be created from the backup. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the new OpenSearch cluster to be created from the backup. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the new OpenSearch cluster to be created from the backup as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Deployment environment of the new OpenSearch cluster to be created from the backup. |
config_spec | ConfigCreateSpec Required. Configuration for the new OpenSearch cluster to be created from the backup. |
network_id | string Required. ID of the network to create the cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
folder_id | string Required. ID of the folder to create the OpenSearch cluster in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
ConfigCreateSpec
Field | Description |
---|---|
version | string OpenSearch version. |
admin_password | string Required. OpenSearch admin password. |
opensearch_spec | OpenSearchCreateSpec OpenSearch configuration. |
dashboards_spec | DashboardsCreateSpec Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearchCreateSpec
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup OpenSearch type host groups of the cluster. |
config | oneof: opensearch_config_2 |
opensearch_config_2 | config.OpenSearchConfig2 |
NodeGroup
Field | Description |
---|---|
name | string Required. Name of the group. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
resources | Resources Resources allocated to the hosts. |
hosts_count | int64 Number of hosts in the group. The minimum value is 1. |
zone_ids[] | string IDs of the availability zones the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
subnet_ids[] | string IDs of the subnets that the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
assign_public_ip | bool Determines whether a public IP is assigned to the hosts in the group. |
roles[] | OpenSearch.GroupRole Roles of the hosts in the group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
DashboardsCreateSpec
Field | Description |
---|---|
node_groups[] | NodeGroup Dashboards type host groups of the cluster. |
NodeGroup
Field | Description |
---|---|
name | string Required. Name of the group. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
resources | Resources Resources allocated to the hosts. |
hosts_count | int64 Number of hosts in the group. The minimum value is 1. |
zone_ids[] | string IDs of the availability zones the hosts belong to. |
subnet_ids[] | string IDs of the subnets that the hosts belong to. The maximum number of elements is 10. The maximum string length in characters for each value is 50. |
assign_public_ip | bool Determines whether a public IP is assigned to the hosts in the group. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RestoreClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the new OpenSearch cluster being created from a backup. |
backup_id | string ID of the backup being used for creating a cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
RescheduleMaintenance
Reschedules a planned maintenance operation.
rpc RescheduleMaintenance (RescheduleMaintenanceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RescheduleMaintenanceMetadata
Operation.response:Cluster
RescheduleMaintenanceRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to reschedule the maintenance operation for. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
reschedule_type | enum RescheduleType Required. The type of the reschedule request.
|
delayed_until | google.protobuf.Timestamp The time until which this maintenance operation should be delayed. The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks. The value can also point to a moment in the past if reschedule_type.IMMEDIATE reschedule type is selected. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RescheduleMaintenanceMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster where the reschedule is applied. |
delayed_until | google.protobuf.Timestamp The time until which this maintenance operation is to be delayed. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
ListBackups
Returns a list of available backups for the specified OpenSearch cluster.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterBackupsResponse
Field | Description |
---|---|
backups[] | Backup List of the OpenSearch cluster backups. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
source_cluster_id | string ID of the OpenSearch cluster that the backup was created for. |
started_at | google.protobuf.Timestamp Time when the backup operation was started. |
created_at | google.protobuf.Timestamp Time when the backup operation was completed. |
indices[] | string Names of indices in the backup. The maximum number of elements is 100. |
opensearch_version | string OpenSearch version used to create the backup. |
size_bytes | int64 Size of the backup in bytes. |
indices_total | int64 The number of indices in the backup. |
Move
Moves the specified OpenSearch cluster to the specified folder.
rpc Move (MoveClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:MoveClusterMetadata
Operation.response:Cluster
MoveClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to move. The maximum string length in characters is 50. |
destination_folder_id | string Required. ID of the destination folder. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
MoveClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster being moved. |
source_folder_id | string ID of the source folder. |
destination_folder_id | string ID of the destnation folder. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
Start
Starts the specified OpenSearch cluster.
rpc Start (StartClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to start. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StartClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster being started. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
Stop
Stops the specified OpenSearch cluster.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to stop. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StopClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster being stopped. |
Cluster
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folder_id | string ID of the folder that the OpenSearch cluster belongs to. |
created_at | google.protobuf.Timestamp Time when the cluster was created. |
name | string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource. |
environment | enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the OpenSearch cluster. |
config | ClusterConfig Configuration of the OpenSearch cluster. |
network_id | string ID of the cloud network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups. |
service_account_id | string ID of the service account used to access Object Storage. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
maintenance_window | MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window . |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the OpenSearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of the OpenSearch server software. |
opensearch | OpenSearch OpenSearch configuration. |
dashboards | Dashboards Dashboards configuration. |
access | Access Access policy for external services. |
OpenSearch
Field | Description |
---|---|
plugins[] | string Names of the cluster plugins. |
node_groups[] | NodeGroup Host groups of the OpenSearch type. |
config | oneof: opensearch_config_set_2 |
opensearch_config_set_2 | config.OpenSearchConfigSet2 |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. Must be 1-63 characters long. |
resources | 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. |
roles[] | enum GroupRole Roles of the host group. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Dashboards
Field | Description |
---|---|
node_groups[] | NodeGroup Host groups of the Dashboards type. |
NodeGroup
Field | Description |
---|---|
name | string Name of the group. 1-63 characters long. |
resources | 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. |
Access
Field | Description |
---|---|
data_transfer | bool Determines whether the access to Data Transfer is allowed. |
serverless | bool Determines whether the access to Serverless is allowed. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The description of the operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Delay time for the maintenance operation. |
latest_maintenance_time | google.protobuf.Timestamp Time of the last maintenance window. |
next_maintenance_window_time | google.protobuf.Timestamp Time of the next maintenance window. |
ListLogs
Retrieves logs for the specified OpenSearch cluster. For detailed description, see the Logs section in the developer's guide.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to request logs for. To get the OpenSearch cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from log table to request. If no columns are specified, entire log records are returned. |
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
always_next_page_token | bool The service always returns a ListClusterLogsResponse.next_page_token, even if the current page is empty. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Examples of a filter:
|
service_type | enum ServiceType Type of the service to request logs about.
|
ListClusterLogsResponse
Field | Description |
---|---|
logs[] | LogRecord Requested log records. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. This value is interchangeable with the StreamLogRecord.next_record_token from StreamLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Time when the log was recorded. |
message | map<string,string> Contents of the log record. |
StreamLogs
Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster. The maximum string length in characters is 50. |
column_filter[] | string Columns from log table to get in the response. If no columns are specified, entire log records are returned. |
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs are sent as well as the new ones as they appear. In essence it has tail -f semantics. |
record_token | string Record token. Set record_token to the next_record_token returned by the previous StreamLogs request to start streaming from the next log record. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Examples of a filter:
|
service_type | enum ServiceType Type of the service to request logs about.
|
StreamLogRecord
Field | Description |
---|---|
record | LogRecord One of the requested log records. |
next_record_token | string This token allows you to continue streaming logs starting from the exact same record. To do that, specify value of next_record_token as the value for StreamLogs.record_token parameter in the next StreamLogs request. This value is interchangeable with ListLogs.next_page_token from ListLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Time when the log was recorded. |
message | map<string,string> Contents of the log record. |
ListOperations
Retrieves the list of Operation resources for the specified cluster.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster resource to list operations for. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of Operation resources for the specified OpenSearch cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any 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 |
ListHosts
Retrieves a list of hosts for the specified cluster.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster. To get the OpenSearch cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterHostsResponse
Field | Description |
---|---|
hosts[] | Host Requested list of hosts for the cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Host
Field | Description |
---|---|
name | string Required. Name of the OpenSearch host. The host name is assigned by the platform at creation time and cannot be changed. The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host. |
cluster_id | string Required. ID of the OpenSearch cluster. The ID is assigned by the platform at creation time. |
zone_id | string ID of the availability zone the OpenSearch host belongs to. |
resources | Resources Resources allocated to the OpenSearch host. |
type | enum Type Type of the host.
|
health | enum Health Status code of the aggregated health of the host.
|
subnet_id | string ID of the subnet that the host belongs to. |
assign_public_ip | bool Determines whether a public IP is assigned to the host. |
system | SystemMetrics Resources used by the host. |
node_group | string Name of the host group that the host belongs to. |
roles[] | OpenSearch.GroupRole Roles of the host. |
CPUMetric
Field | Description |
---|---|
timestamp | int64 Time of the record. |
used | double Percentage of the CPU used. |
MemoryMetric
Field | Description |
---|---|
timestamp | int64 Time of the record. |
used | int64 The amount of RAM used, in bytes. |
total | int64 Total amount of RAM allocated to the host. |
DiskMetric
Field | Description |
---|---|
timestamp | int64 Time of the record. |
used | int64 The amount of disk space used, in bytes. |
total | int64 Total amount of disk space allocated to the host. |
SystemMetrics
Field | Description |
---|---|
cpu | CPUMetric CPU usage of the host. |
memory | MemoryMetric RAM usage of the host. |
disk | DiskMetric Disk usage of the host. |
Resources
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: network-hdd , network-ssd or local-ssd . |
AddOpenSearchNodeGroup
Creates an OpenSearch type host group.
rpc AddOpenSearchNodeGroup (AddOpenSearchNodeGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddNodeGroupMetadata
Operation.response:google.protobuf.Empty
AddOpenSearchNodeGroupRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to create the OpenSearch type host group in. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
node_group_spec | OpenSearchCreateSpec.NodeGroup Configuration of the new host group. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
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. |
DeleteOpenSearchNodeGroup
Deletes an OpenSearch type host group.
rpc DeleteOpenSearchNodeGroup (DeleteOpenSearchNodeGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteNodeGroupMetadata
Operation.response:google.protobuf.Empty
DeleteOpenSearchNodeGroupRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to delete the OpenSearch type host group in. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
name | string Name of the OpenSearch type host group to delete. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteNodeGroupMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster where the host group is being deleted. |
name | string Name of the host group being deleted. |
UpdateOpenSearchNodeGroup
Updates an OpenSearch type host group.
rpc UpdateOpenSearchNodeGroup (UpdateOpenSearchNodeGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateNodeGroupMetadata
Operation.response:google.protobuf.Empty
UpdateOpenSearchNodeGroupRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to update the OpenSearch type host group in. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
name | string Required. Name of the OpenSearch type host group to be updated. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the host group configuration should be updated. |
node_group_spec | OpenSearchNodeGroupUpdateSpec New configuration for the host group. |
OpenSearchNodeGroupUpdateSpec
Field | Description |
---|---|
resources | Resources Resources allocated to the hosts. |
hosts_count | int64 Number of hosts in the group. |
roles[] | OpenSearch.GroupRole Opensearch roles applicable to the node group. |
zone_ids[] | string IDs of the availability zones for hosts |
subnet_ids[] | string IDs of the subnets for hosts |
assign_public_ip | bool Whether the hosts should get a public IP address. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateNodeGroupMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster where the host group is being updated. |
name | string Name of the host group being updated. |
AddDashboardsNodeGroup
Creates a Dashboards type host group.
rpc AddDashboardsNodeGroup (AddDashboardsNodeGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddNodeGroupMetadata
Operation.response:google.protobuf.Empty
AddDashboardsNodeGroupRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to create the Dashboards type host group in. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
node_group_spec | DashboardsCreateSpec.NodeGroup Configuration of the new host group. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
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. |
DeleteDashboardsNodeGroup
Deletes a Dashboards type host group.
rpc DeleteDashboardsNodeGroup (DeleteDashboardsNodeGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteNodeGroupMetadata
Operation.response:google.protobuf.Empty
DeleteDashboardsNodeGroupRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to delete the Dashboards type host group in. To get the ID, use a ClusterService.List request. The maximum string length in characters is 50. |
name | string Required. Name of the Dashboards type host group to delete. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteNodeGroupMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster where the host group is being deleted. |
name | string Name of the host group being deleted. |
UpdateDashboardsNodeGroup
Updates a Dashboards type host group.
rpc UpdateDashboardsNodeGroup (UpdateDashboardsNodeGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateNodeGroupMetadata
Operation.response:google.protobuf.Empty
UpdateDashboardsNodeGroupRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the OpenSearch cluster to update the Dashboards type host group in. The maximum string length in characters is 50. |
name | string Required. Name of the Dashboards type host group to be updated. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the host group configuration should be updated. |
node_group_spec | DashboardsNodeGroupUpdateSpec New configuration for the host group. |
DashboardsNodeGroupUpdateSpec
Field | Description |
---|---|
resources | Resources Resources allocated to the hosts. |
hosts_count | int64 Number of hosts in the group. |
zone_ids[] | string IDs of the availability zones for hosts |
subnet_ids[] | string IDs of the subnets for hosts |
assign_public_ip | bool Whether the hosts should get a public IP address. |
Resources
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: network-hdd , network-ssd or local-ssd . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateNodeGroupMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster where the host group is being updated. |
name | string Name of the host group being updated. |
GetAuthSettings
Retrieves auth settings for specified cluster.
rpc GetAuthSettings (GetAuthSettingsRequest) returns (AuthSettings)
GetAuthSettingsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the OpenSearch cluster. The maximum string length in characters is 50. |
AuthSettings
Field | Description |
---|---|
saml | SAMLSettings SAML settings |
SAMLSettings
Field | Description |
---|---|
enabled | bool |
idp_entity_id | string Required. The entity ID of your IdP. The maximum string length in characters is 250. |
idp_metadata_file | bytes Required. The SAML 2.0 metadata file of your IdP. The maximum string length in characters is 10000. |
sp_entity_id | string Required. The entity ID of the service provider. The maximum string length in characters is 250. |
dashboards_url | string Required. The OpenSearch Dashboards base URL. The maximum string length in characters is 250. |
roles_key | string Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used. The maximum string length in characters is 250. |
subject_key | string Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used. The maximum string length in characters is 250. |
UpdateAuthSettings
Updates auth settings for specified cluster.
rpc UpdateAuthSettings (UpdateAuthSettingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateAuthSettingsMetadata
Operation.response:AuthSettings
UpdateAuthSettingsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the OpenSearch cluster. The maximum string length in characters is 50. |
settings | AuthSettings Required. Auth settings. |
AuthSettings
Field | Description |
---|---|
saml | SAMLSettings SAML settings |
SAMLSettings
Field | Description |
---|---|
enabled | bool |
idp_entity_id | string Required. The entity ID of your IdP. The maximum string length in characters is 250. |
idp_metadata_file | bytes Required. The SAML 2.0 metadata file of your IdP. The maximum string length in characters is 10000. |
sp_entity_id | string Required. The entity ID of the service provider. The maximum string length in characters is 250. |
dashboards_url | string Required. The OpenSearch Dashboards base URL. The maximum string length in characters is 250. |
roles_key | string Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used. The maximum string length in characters is 250. |
subject_key | string Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used. The maximum string length in characters is 250. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateAuthSettingsMetadata
Field | Description |
---|---|
cluster_id | string ID of the OpenSearch cluster. |
AuthSettings
Field | Description |
---|---|
saml | SAMLSettings SAML settings |