Package google.cloud.backupdr.v1

Index

BackupDR

The BackupDR Service

CreateManagementServer

rpc CreateManagementServer(CreateManagementServerRequest) returns (Operation)

Creates a new ManagementServer in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteManagementServer

rpc DeleteManagementServer(DeleteManagementServerRequest) returns (Operation)

Deletes a single ManagementServer.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetManagementServer

rpc GetManagementServer(GetManagementServerRequest) returns (ManagementServer)

Gets details of a single ManagementServer.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListManagementServers

rpc ListManagementServers(ListManagementServersRequest) returns (ListManagementServersResponse)

Lists ManagementServers in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateManagementServerRequest

Request message for creating a management server instance.

Fields
parent

string

Required. The management server project and location in the format projects/{project_id}/locations/{location}. In Cloud Backup and DR locations map to GCP regions, for example us-central1.
management_server_id

string

Required. The name of the management server to create. The name must be unique for the specified project and location.
management_server

ManagementServer

Required. A management server resource
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteManagementServerRequest

Request message for deleting a management server instance.

Fields
name

string

Required. Name of the resource
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

GetManagementServerRequest

Request message for getting a management server instance.

Fields
name

string

Required. Name of the management server resource name, in the format projects/{project_id}/locations/{location}/managementServers/{resource_name}

ListManagementServersRequest

Request message for listing management servers.

Fields
parent

string

Required. The project and location for which to retrieve management servers information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve management servers for all locations, use "-" for the {location} value.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListManagementServersResponse

Response message for listing management servers.

Fields
management_servers[]

ManagementServer

The list of ManagementServer instances in the project for the specified location.

If the {location} value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ManagementServer

ManagementServer describes a single BackupDR ManagementServer instance.

Fields
name

string

Output only. Identifier. The resource name.
description

string

Optional. The description of the ManagementServer instance (2048 characters or less).
labels

map<string, string>

Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.
create_time

Timestamp

Output only. The time when the instance was created.
update_time

Timestamp

Output only. The time when the instance was updated.
type

InstanceType

Optional. The type of the ManagementServer resource.
management_uri

ManagementURI

Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
workforce_identity_based_management_uri

WorkforceIdentityBasedManagementURI

Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
state

InstanceState

Output only. The ManagementServer state.
networks[]

NetworkConfig

Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
etag

string

Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
oauth2_client_id

string

Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
workforce_identity_based_oauth2_client_id

WorkforceIdentityBasedOAuth2ClientID

Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
ba_proxy_uri[]

string

Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
satisfies_pzs

BoolValue

Output only. Reserved for future use.
satisfies_pzi

bool

Output only. Reserved for future use.

InstanceState

State of Management server instance.

Enums
INSTANCE_STATE_UNSPECIFIED State not set.
CREATING The instance is being created.
READY The instance has been created and is fully usable.
UPDATING The instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.
DELETING The instance is being deleted.
REPAIRING The instance is being repaired and may be unstable.
MAINTENANCE Maintenance is being performed on this instance.
ERROR The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of Instance resource.

InstanceType

Type of backup service resource.

Enums
INSTANCE_TYPE_UNSPECIFIED Instance type is not mentioned.
BACKUP_RESTORE Instance for backup and restore management (i.e., AGM).

ManagementURI

ManagementURI for the Management Server resource.

Fields
web_ui

string

Output only. The ManagementServer AGM/RD WebUI URL.
api

string

Output only. The ManagementServer AGM/RD API URL.

NetworkConfig

Network configuration for ManagementServer instance.

Fields
network

string

Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.
peering_mode

PeeringMode

Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.

PeeringMode

VPC peering modes supported by Cloud BackupDR.

Enums
PEERING_MODE_UNSPECIFIED Peering mode not set.
PRIVATE_SERVICE_ACCESS Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Cloud BackupDR.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.
additional_info

map<string, string>

Output only. AdditionalInfo contains additional Info related to backup plan association resource.

WorkforceIdentityBasedManagementURI

ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.

Fields
first_party_management_uri

string

Output only. First party Management URI for Google Identities.
third_party_management_uri

string

Output only. Third party Management URI for External Identity Providers.

WorkforceIdentityBasedOAuth2ClientID

OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,

Fields
first_party_oauth2_client_id

string

Output only. First party OAuth Client ID for Google Identities.
third_party_oauth2_client_id

string

Output only. Third party OAuth Client ID for External Identity Providers.