Scaleway logo
Cloud Essentials for Opensearch API

scaleway.searchdb.v1alpha1.Deployment

id
​string

Unique identifier of the Deployment. (UUID format)

name
​string

Name of the Deployment.

organization_id
​string

ID of the Organization containing the Deployment. (UUID format)

project_id
​string

ID of the Project containing the Deployment. (UUID format)

Status of the Deployment.

Enum values:
unknown_status
ready
creating
initializing
upgrading
deleting
error
locked
Default: unknown_status
tags
​string[]

Tags of the Deployment.

node_count
​integer · uint32

Number of nodes allocated per deployment.

node_type
​string

Node type used in deployment.

Volume type and size.

Exposed endpoints.

created_at
​string | null · date-time

Creation date of the Deployment. (RFC 3339 format)

updated_at
​string | null · date-time

Date when last update was done to the Deployment. (RFC 3339 format)

version
​string

Opensearch version of the Deployment.

region
​string

Region the Deployment is located.

scaleway.searchdb.v1alpha1.Deployment.Status

string · enum
Enum values:
unknown_status
ready
creating
initializing
upgrading
deleting
error
locked
Default: unknown_status

scaleway.searchdb.v1alpha1.Endpoint

id
​string

Unique identifier of the Endpoint. (UUID format)

List of available services, their ports and URLs.

​
​

scaleway.searchdb.v1alpha1.Endpoint.PrivateNetworkDetails

private_network_id
​string

(UUID format)

scaleway.searchdb.v1alpha1.Endpoint.PublicDetails

scaleway.searchdb.v1alpha1.Endpoint.Service

name
​string
port
​integer · uint32
url
​string

scaleway.searchdb.v1alpha1.EndpointSpec

​
​

scaleway.searchdb.v1alpha1.EndpointSpec.PrivateNetworkDetails

private_network_id
​string

(UUID format)

scaleway.searchdb.v1alpha1.EndpointSpec.PublicDetails

scaleway.searchdb.v1alpha1.ListDeploymentsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
updated_at_asc
updated_at_desc
Default: created_at_asc

scaleway.searchdb.v1alpha1.ListDeploymentsResponse

List of deployments available.

total_count
​integer · uint64

Total number of objects.

scaleway.searchdb.v1alpha1.ListNodeTypesRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
vcpus_asc
vcpus_desc
memory_asc
memory_desc
Default: name_asc

scaleway.searchdb.v1alpha1.ListNodeTypesResponse

Node types compatible with the cluster.

total_count
​integer · uint64

Number of available node types to return.

scaleway.searchdb.v1alpha1.ListUsersRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.searchdb.v1alpha1.ListUsersResponse

total_count
​integer · uint64

scaleway.searchdb.v1alpha1.ListVersionsRequest.OrderBy

string · enum
Enum values:
version_asc
version_desc
Default: version_asc

scaleway.searchdb.v1alpha1.ListVersionsResponse

List of versions.

total_count
​integer · uint64

Number of versions in the list.

scaleway.searchdb.v1alpha1.NodeType

Stock status of the node type.

Enum values:
unknown_stock
low_stock
out_of_stock
available
Default: unknown_stock
name
​string

Name of the node type.

description
​string

Description of the node type.

vcpus
​integer · uint32

Number of vCPUs available.

memory_bytes
​integer · uint64

Amount of memory available. (in bytes)

disabled
​boolean

Defines whether the node type is disabled.

beta
​boolean

Defines whether the node type is in beta.

instance_range
​string

Instance range associated with the NodeType offer.

Available storage options for the Node Type.

scaleway.searchdb.v1alpha1.NodeType.StockStatus

string · enum
Enum values:
unknown_stock
low_stock
out_of_stock
available
Default: unknown_stock

scaleway.searchdb.v1alpha1.NodeType.VolumeType

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
description
​string
min_size_bytes
​integer · uint64

(in bytes)

max_size_bytes
​integer · uint64

(in bytes)

chunk_size_bytes
​integer · uint64

(in bytes)

scaleway.searchdb.v1alpha1.User

username
​string

scaleway.searchdb.v1alpha1.Version

version
​string

Opensearch Version.

end_of_life
​string | null · date-time

End of life date of the version. (RFC 3339 format)

disabled
​boolean

Parameter that tell if the version is disabled.

beta
​boolean

Parameter that tell if the version is in beta.

scaleway.searchdb.v1alpha1.Volume

Define the type of the Volume.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
size_bytes
​integer · uint64

Define the size of the Volume. (in bytes)

scaleway.searchdb.v1alpha1.Volume.Type

string · enum
Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type

scaleway.std.File

name
​string
content_type
​string
content
​string