Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1339136214.2 KB
projects

Creates a new ManagementServer in a given project and location.

post/v1/{+parent}/managementServers

Path parameters

parentstring required

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

Query parameters

managementServerIdstring

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

requestIdstring

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).

Request body

etagstring

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

satisfiesPzsboolean

Output only. Reserved for future use.

createTimestring google-datetime

Output only. The time when the instance was created.

type'INSTANCE_TYPE_UNSPECIFIED' | 'BACKUP_RESTORE'

Optional. The type of the ManagementServer resource.

baProxyUristring[]

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

namestring

Output only. Identifier. The resource name.

updateTimestring google-datetime

Output only. The time when the instance was updated.

oauth2ClientIdstring

Output only. The OAuth 2.0 client id is required to make API calls to the Backup and DR 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).

descriptionstring

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

labelsobject

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

state'INSTANCE_STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'UPDATING' | 'DELETING' | 'REPAIRING' | 'MAINTENANCE' | 'ERROR'

Output only. The ManagementServer state.

satisfiesPziboolean

Output only. Reserved for future use.

Response

Successful response