Sign in

v1

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

Creates a new instance in a given project and location.

post/v1/{+parent}/instances

Path parameters

parentstring required

Required. Value for parent.

Query parameters

instanceIdstring

Required. ID of the instance to be created.

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

labelsobject

Optional. Labels as key value pairs. Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. For more information, see Requirements for labels.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'PAUSED' | 'UNKNOWN'

Output only. Current state of the instance.

createTimestring google-datetime

Output only. Create timestamp.

updateTimestring google-datetime

Output only. Update timestamp.

stateNote'STATE_NOTE_UNSPECIFIED' | 'PAUSED_CMEK_UNAVAILABLE' | 'INSTANCE_RESUMING'

Output only. An optional field providing information about the current instance state.

namestring

Identifier. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id} project_number: Maps to a unique int64 id assigned to each project. location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

kmsKeystring

Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.

Response

Successful response