Common models

Access.DataService

Option

Description

DATA_SERVICE_INVALID

DATA_SERVICE_VISUALIZATION

Allow access for DataLens

DATA_SERVICE_TRANSFER

Allow access for DataTransfer

ClusterStatus

Option

Description

CLUSTER_STATUS_INVALID

Invalid cluster status value.

CLUSTER_STATUS_ALIVE

Cluster is running and all cluster hosts are healthy.

CLUSTER_STATUS_DEGRADED

Cluster is working below capacity (at least one host in the cluster is not healthy).

CLUSTER_STATUS_DEAD

Cluster is inoperable (all hosts in the cluster are inoperable).

CLUSTER_STATUS_UNKNOWN

State of the cluster is unknown (all hosts in the cluster are in unknown state).

CLUSTER_STATUS_CREATING

Cluster is being created.

CLUSTER_STATUS_UPDATING

Cluster is being updated.

CLUSTER_STATUS_STOPPING

Cluster is stopping.

CLUSTER_STATUS_STOPPED

Cluster stopped.

CLUSTER_STATUS_STARTING

Cluster is starting.

CLUSTER_STATUS_ERROR

Cluster encountered a problem and cannot operate.

HostStatus

Option

Description

HOST_STATUS_INVALID

Host is in unknown state (we have no data)

HOST_STATUS_ALIVE

Host is alive and well (all services are alive)

HOST_STATUS_DEAD

Host is inoperable (it cannot perform any of its essential functions)

HOST_STATUS_DEGRADED

Host is partially alive (it can perform some of its essential functions)

HOST_STATUS_CREATING

Host is being created (some services may not be alive yet)

HOST_STATUS_STOPPING

Host is stopping due to user's request (all services would be stopped soon)

HOST_STATUS_STOPPED

Host is stopped due to user's request (all services are not available)

HOST_STATUS_STARTING

Host is starting (all services would be alive soon)

RescheduleType

Option

Description

RESCHEDULE_TYPE_INVALID

RESCHEDULE_TYPE_IMMEDIATE

RESCHEDULE_TYPE_NEXT_AVAILABLE_WINDOW

RESCHEDULE_TYPE_SPECIFIC_TIME

Operation.Status

Option

Description

STATUS_INVALID

Invalid status value.

STATUS_PENDING

Operation is pending execution.

STATUS_RUNNING

Operation is in progress.

STATUS_DONE

Operation is completed.

Access

Field

Description

ipv4_cidr_blocks

doublecloud.v1.Access.CidrBlockList The list of ipv4 IPs (in 'CIDR' notation) of external networks that are allowed to connect to the instance

ipv6_cidr_blocks

doublecloud.v1.Access.CidrBlockList The list of ipv6 IPs (in 'CIDR' notation) of external networks that are allowed to connect to the instance

data_services

doublecloud.v1.Access.DataServiceList

Access.CidrBlock

Field

Description

value

string

description

string

Access.CidrBlockList

Field

Description

values

list

values[]

doublecloud.v1.Access.CidrBlock

Access.DataServiceList

Field

Description

values

list

values[]

doublecloud.v1.Access.DataService

DataEncryption

Field

Description

enabled

google.protobuf.BoolValue deprecated. Encryption is always enabled.

AnytimeMaintenanceWindow

Field

Description

MaintenanceOperation

Field

Description

info

string Length of info string should be limited by 256 characters

scheduled_maintenance_time

google.protobuf.Timestamp

deadline_maintenance_time

google.protobuf.Timestamp

next_maintenance_window_time

google.protobuf.Timestamp

MaintenanceWindow

Field

Description

policy

one of: anytime / weekly_maintenance_window

anytime

doublecloud.v1.AnytimeMaintenanceWindow

weekly_maintenance_window

doublecloud.v1.WeeklyMaintenanceWindow

WeeklyMaintenanceWindow

Field

Description

day

google.type.DayOfWeek

hour

int64 Hour of the day in UTC (1 - 24).

Operation

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

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

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

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

resource_id

string ID of the resource operation performed on.

Operation.MetadataEntry

Field

Description

key

string

value

string

NextPage

Field

Description

token

string This token allows you to get the next page of results for list requests. If the number of results is larger than [Paging.page_size], use the [token] as the value for the [Paging.page_token] parameter in the next list request. Each subsequent list request will have its own [token] to continue paging through the results.

Paging

Field

Description

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 [NextPage.token] that can be used to get the next page of results in subsequent list requests.

page_token

string Page token. To get the next page of results, set [page_token] to the [NextPage.token] returned by a previous list request.

Previous