Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1374955.2 KB
folders

Creates a new policy orchestrator under the given folder resource. name field of the given orchestrator are ignored and instead replaced by a product of parent and policy_orchestrator_id. Orchestrator state field might be only set to ACTIVE, STOPPED or omitted (in which case, the created resource will be in ACTIVE state anyway).

post/v2/{+parent}/policyOrchestrators

Path parameters

parentstring required

Required. The parent resource name in the form of: * organizations/{organization_id}/locations/global * folders/{folder_id}/locations/global * projects/{project_id_or_number}/locations/global

Query parameters

policyOrchestratorIdstring

Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.

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

actionstring

Required. Action to be done by the orchestrator in projects/{project_id}/zones/{zone_id} locations defined by the orchestration_scope. Allowed values: - UPSERT - Orchestrator will create or update target resources. - DELETE - Orchestrator will delete target resources, if they exist

namestring

Immutable. Identifier. In the following format: * organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id} * folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id} * projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}

createTimestring google-datetime

Output only. Timestamp when the policy orchestrator resource was created.

descriptionstring

Optional. Freeform text describing the purpose of the resource.

updateTimestring google-datetime

Output only. Timestamp when the policy orchestrator resource was last modified.

etagstring

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labelsobject

Optional. Labels as key value pairs

reconcilingboolean

Output only. Set to true, if there are ongoing changes being applied by the orchestrator.

statestring

Optional. State of the orchestrator. Can be updated to change orchestrator behaviour. Allowed values: - ACTIVE - orchestrator is actively looking for actions to be taken. - STOPPED - orchestrator won't make any changes. Note: There might be more states added in the future. We use string here instead of an enum, to avoid the need of propagating new states to all the client code.

Response

Successful response