openapi: 3.2.0
info:
description: "Microsoft Azure:
\nOracle Azure Connector Resource:: The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:\n
\n - Using a Bearer Access Token
\n
\n\nOracle Azure Blob Container Resource: The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. \nThis resource can then be reused across multiple Exadata VM clusters in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) to mount the Azure container.\n\nOracle Azure Blob Mount Resource: The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\nIt relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.\n\nDiscover Azure Vaults and Keys Resource: The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.\n\nOracle Azure Vault: The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.\n\nOracle Azure Key: Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.\n\n
\n\nGoogle Cloud:
\nOracle Google Cloud Connector Resource: The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n\nDiscover Google Key Rings and Keys Resource: The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.\n\nGoogle Key Rings Resource: The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.\n\nGoogle Key Resource: The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.\n
\n\nAWS:
\nOracle AWS Connector Resource: The Oracle AWS Connector Resource is used to install the AWS Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n\nOracle AWS Key Resource: The Oracle AWS Key Resource is used to register and manage a AWS Key within Oracle Cloud Infrastructure (OCI).\n"
title: Oracle Database MultiCloud Data Plane Integration Db Multicloud GCP Provider API
version: '20240501'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/70d1a303c64ae25a654e1897690653227087a9daff98ffa409104e364edd293c.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Oracle Database MultiCloud Data Plane Integration OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/70d1a303c64ae25a654e1897690653227087a9daff98ffa409104e364edd293c.yaml
what: the harvested document for Oracle Database MultiCloud Data Plane Integration
servers:
- url: http://127.0.0.1/20240501
- url: https://127.0.0.1/20240501
tags:
- name: DbMulticloudGCPProvider
paths:
/oracleDbGcpIdentityConnector:
get:
description: 'Lists all Oracle DB GCP Identity Connectors based on the specified filters.
'
operationId: ListOracleDbGcpIdentityConnectors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorDisplayNameQueryParam'
- $ref: '#/components/parameters/OracleDbResourceIdQueryParam'
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbGcpIdentityConnectorSummaryCollection object.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain. For
important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpIdentityConnectorSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists all Oracle DB GCP Identity Connectors based on the specified filters.
tags:
- DbMulticloudGCPProvider
x-example: 'GET /20240501/oracleDbGcpIdentityConnector
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
post:
description: 'Creates Oracle DB GCP Identity Connector resource.
'
operationId: CreateOracleDbGcpIdentityConnector
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: 'CreatesOracle DB GCP Identity Connector resource.
'
headers:
content-location:
description: URI of the resource
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the resource
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpIdentityConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Creates Oracle DB GCP Identity Connector resource.
'
tags:
- DbMulticloudGCPProvider
x-example: "POST /20240501/oracleDbGcpIdentityConnector\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"id\": \"ocid1.oracledbgcpconnector.oc1..\",\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"displayName\": \"Display Name\",\n \"projectNumber\": \"projectNumber\",\n \"issuerUrl\": \"issuerUrl\",\n \"resourceId\":\"VMClusterID\",\n \"gcpWorkloadIdentityPoolId\": \"string\",\n \"gcpWorkloadIdentityProviderId\": \"string\",\n \"gcpResourceServiceAgentId\": \"string\",\n \"lifecycleState\": \"CREATING\",\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n }\n}\n"
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOracleDbGcpIdentityConnectorDetails'
description: 'Details for to Create Oracle DB GCP Identity Connector resource.
'
required: true
/oracleDbGcpIdentityConnector/{oracleDbGcpIdentityConnectorId}:
delete:
description: 'Deletes the Oracle DB GCP Identity Connector resource and removes the associated connector from the database resource.
'
operationId: DeleteOracleDbGcpIdentityConnector
parameters:
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Oracle DB GCP Identity connector will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Oracle DB GCP Identity Connector resource.
tags:
- DbMulticloudGCPProvider
x-example: 'DELETE /20250501/oracleDbGcpIdentityConnector/<oracleDbGcpIdentityConnectorId>
Host: multi-cloud-db.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
get:
description: 'Retrieves the Oracle DB GCP Identity Connector for a specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: GetOracleDbGcpIdentityConnector
parameters:
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbGcpIdentityConnector object.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpIdentityConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves the Oracle DB GCP Identity Connector for a specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- DbMulticloudGCPProvider
x-example: 'GET /20250501/oracleDbGcpIdentityConnector/<oracleDbGcpIdentityConnectorId>
Host: multi-cloud-db.us-ashburn-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
put:
description: 'Modifies the existing Oracle DB GCP Identity Connector resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: UpdateOracleDbGcpIdentityConnector
parameters:
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Oracle DB GCP Identity Connector will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Modifies the existing Oracle DB GCP Identity Connector resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- DbMulticloudGCPProvider
x-example: "PUT /20240501/oracleDbGcpIdentityConnector/<oracleDbGcpIdentityConnectorId>\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"id\": \"ocid1.oracledbgcpconnector.oc1..\",\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"displayName\": \"Display Name\",\n \"projectNumber\": \"projectNumber\",\n \"issuerUrl\": \"issuerUrl\",\n \"resourceId\":\"VMClusterID\",\n \"gcpWorkloadIdentityPoolId\": \"string\",\n \"gcpWorkloadIdentityProviderId\": \"string\",\n \"gcpResourceServiceAgentId\": \"string\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n },\n \"systemTags\": {}\n}\n"
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOracleDbGcpIdentityConnectorDetails'
description: Details for to update OracleDbGcpIdentityConnector.
required: true
/oracleDbGcpIdentityConnector/{oracleDbGcpIdentityConnectorId}/actions/changeCompartment:
post:
description: Moves the Oracle DB GCP Identity Connector resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
operationId: ChangeOracleDbGcpIdentityConnectorCompartment
parameters:
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Oracle DB GCP Identity Connector resource will be moved to the new compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves the Oracle DB GCP Identity Connector resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
tags:
- DbMulticloudGCPProvider
x-example: "POST /20240501/oracleDbGcpIdentityConnector/<oracleDbGcpIdentityConnectorId>/actions/changeCompartment\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n}\n"
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeOracleDbGcpIdentityConnectorCompartmentDetails'
description: Moves the Oracle DB GCP Identity Connector resource into a different compartment.
required: true
/oracleDbGcpIdentityConnector/{oracleDbGcpIdentityConnectorId}/actions/refresh:
post:
description: 'Refreshes the Oracle DB GCP Connector resource.
'
operationId: RefreshOracleDbGcpIdentityConnector
parameters:
- $ref: '#/components/parameters/OracleDbGcpIdentityConnectorIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'Accepted the request, The Oracle DB GCP Connector resource object will be synced with GCP Connector.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Refreshes the Oracle DB GCP Connector resource.
tags:
- DbMulticloudGCPProvider
x-example: 'POST /20240501/oracleDbGcpIdentityConnector/<oracleDbGcpIdentityConnectorId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpIdentityConnector'
/oracleDbGcpKey:
get:
description: 'Lists all Oracle DB Google Cloud Keys based on the specified filters.
'
operationId: ListOracleDbGcpKeys
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/OracleDbGcpKeyDisplayNameQueryParam'
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdQueryParam'
- $ref: '#/components/parameters/OracleDbGcpKeyIdQueryParam'
- $ref: '#/components/parameters/OracleDbGcpKeyLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbGcpKeySummaryCollection object.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain. For
important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpKeySummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists all Oracle DB Google Cloud Keys based on the specified filters.
tags:
- DbMulticloudGCPProvider
x-example: 'GET /20240501/oracleDbGcpKey
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpKey'
/oracleDbGcpKey/{oracleDbGcpKeyId}:
get:
description: 'Retrieves Oracle DB Google Cloud Key details using a specific resource [OCID](/Content/General/Concepts/identifiers.htm).
'
operationId: GetOracleDbGcpKey
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbGcpKey object.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpKey'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves Oracle DB Google Cloud Key details using a specific resource [OCID](/Content/General/Concepts/identifiers.htm).
tags:
- DbMulticloudGCPProvider
x-example: 'GET /20240501/oracleDbGcpKey/<oracleDbGcpKeyId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpKey'
/oracleDbGcpKeyRing:
get:
description: 'Lists the all DB GCP Key Rings based on filters.
'
operationId: ListOracleDbGcpKeyRings
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/OracleGcpKeyRingDisplayNameQueryParam'
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdQueryParam'
- $ref: '#/components/parameters/OracleDbGcpKeyRingLifecycleStateQueryParam'
- $ref: '#/components/parameters/OracleDbGcpConnectorIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbGcpKeyRingSummaryCollection object.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain. For
important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpKeyRingSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists the all DB GCP Key Rings based on filters.
tags:
- DbMulticloudGCPProvider
x-example: 'GET /20240501/oracleDbGcpKeyRing
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
post:
description: 'Creates DB GCP Key Rings based on the provided information and retrieves the associated keys.
'
operationId: CreateOracleDbGcpKeyRing
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: Create GCP Key Ring resource.
headers:
content-location:
description: URI of the resource
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the resource
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpKeyRing'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Creates DB GCP Key Rings based on the provided information and retrieves the associated keys.
'
tags:
- DbMulticloudGCPProvider
x-example: "POST /20240501/oracleDbGcpKeyRing\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"TestDbGcpVault\",\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"oracleDbGcpResourceGroup\": \"QAResourceGroup\",\n \"oracleDbConnectorId\": \"ocid1.oracledbgcpconnector.oc1.iad.\",\n \"gcpKeyRingId\":\"/subscriptions/7080446f-ee76-4aa2-b9dd-c2625f63cab0/resourceGroups/Prasanna.RG/providers/GCP.KeyRing/managedHSMs/PrasannaHSM2\",\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n }\n}\n"
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOracleDbGcpKeyRingDetails'
description: Details for to Create GCP Key Ring Details.
required: true
/oracleDbGcpKeyRing/{oracleDbGcpKeyRingId}:
delete:
description: 'Deletes the GCP Key Ring and its associated metadata.
'
operationId: DeleteOracleDbGcpKeyRing
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'Accepted the request, The GCP Key Ring resource object will be deleted.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the GCP Key Ring and its associated metadata.
tags:
- DbMulticloudGCPProvider
x-example: 'DELETE /20240501/oracleDbGcpKeyRing/<oracleDbGcpKeyRingId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
get:
description: 'Retrieves the Oracle GCP Key Ring details using a specific Container resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: GetOracleDbGcpKeyRing
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbGcpKeyRing object.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbGcpKeyRing'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves the Oracle GCP Key Ring details using a specific Container resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- DbMulticloudGCPProvider
x-example: 'GET /20240501/oracleDbGcpKeyRing/<OracleDbGcpKeyRingId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
put:
description: 'Modifies the existing Oracle GCP Key Ring Details for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: UpdateOracleDbGcpKeyRing
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Oracle GCP Key Ring will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Modifies the existing Oracle GCP Key Ring for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- DbMulticloudGCPProvider
x-example: "PUT /20240501/oracleDbGcpKeyRing/<racleDBGcpVaultId>\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"TestDBGcpBlobContainerUpdated\" ,\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"oracleDbGcpResourceGroup\": \"QAResourceGroup\",\n \"oracleDbConnectorId\": \"ocid1.oracledbgcpconnector.oc1.iad.\",\n \"gcpKeyRingId\":\"/subscriptions/7080446f-ee76-4aa2-b9dd-c2625f63cab0/resourceGroups/Prasanna.RG/providers/GCP.KeyRing/managedHSMs/PrasannaHSM2\",\n \"type\": \"GCP.KeyRing/managedHSMs\",\n \"location\": \"eastus\",\n \"properties\": {\n \"tenantId\": \"some-gcp-tenantId\",\n \"hsmUri\": \"https://hsmkc.uri/\"\n },\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleStateDetails\": null,\n \"timeCreated\": \"2024-02-09T06:31:16.380Z\",\n \"timeUpdated\": \"1970-01-01T00:00:00.000Z\",\n \"lastModification\": null,\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n }\n}\n"
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOracleDbGcpKeyRingDetails'
description: Details for to update OracleDbGcpKeyRing.
required: true
/oracleDbGcpKeyRing/{oracleDbGcpKeyRingId}/actions/changeCompartment:
post:
description: Moves the GCP Key Ring resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
operationId: ChangeOracleDbGcpKeyRingCompartment
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The GCP Key Ring resource will be moved to the new compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves the GCP Key Ring resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
tags:
- DbMulticloudGCPProvider
x-example: "POST /20240501/oracleDbGcpKeyRing/<oracleDbGcpKeyRingId>/actions/changeCompartment\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n}\n"
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeOracleDbGcpKeyRingCompartmentDetails'
description: Moves the GCP Key Ring resource into a different compartment.
required: true
/oracleDbGcpKeyRing/{oracleDbGcpKeyRingId}/actions/refresh:
post:
description: 'Refreshes Oracle GCP Key Ring details from the backend.
'
operationId: RefreshOracleDbGcpKeyRing
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'Accepted the request, The Oracle GCP Key Ring resource object will be synced with GCP Key Ring.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Refreshes Oracle GCP Key Ring details from the backend.
tags:
- DbMulticloudGCPProvider
x-example: 'POST /20240501/oracleDbGcpKeyRing/<oracleDbGcpKeyRingId>/actions/refresh
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshOracleDbGcpKeyRingDetails'
description: Details for to refresh Oracle DD GCP Key Ring.
required: true
/oracleDbGcpKeyRing/{oracleDbGcpKeyRingId}/actions/replicate:
post:
description: 'Replicate Oracle GCP Key Ring details to target region.
'
operationId: ReplicateOracleDbGcpKeyRing
parameters:
- $ref: '#/components/parameters/OracleDbGcpKeyRingIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'Accepted the request, The Oracle GCP Key Ring resource object will be synced with GCP Key Ring.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Replicate Oracle GCP Key Ring details to target region.
tags:
- DbMulticloudGCPProvider
x-example: "POST /20240501/oracleDbGcpKeyRing/<oracleDbGcpKeyRingId>/actions/replicate\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"targetRegion\": \"us-ashburn-1\",\n \"action\": \"CREATE\n}\n"
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/OracleDbGcpKeyRing'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReplicateOracleDbGcpKeyRingDetails'
description: Details for to Replicate Oracle DD GCP Key Ring to target region.
required: true
components:
parameters:
OracleDbGcpKeyRingIdQueryParam:
description: A filter to return Oracle DB GCP Key Rings.
in: query
name: oracleDbGcpKeyRingId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OracleDbGcpIdentityConnectorDisplayNameQueryParam:
description: A filter to return Oracle DB GCP Identity Connector resources that match the specified display name.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
PaginationTokenQueryParam:
description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
in: query
name: page
x-default-description: 'null'
schema:
type: string
minLength: 1
SortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, default is timeCreated.
'
in: query
name: sortBy
x-default-description: 'null'
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
OracleGcpKeyRingDisplayNameQueryParam:
description: A filter to return Oracle DB GCP Key Ring resources that match the specified display name.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OracleDbGcpConnectorIdQueryParam:
description: A filter to return Oracle DB GCP Identity Connector resources that match the specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
in: query
name: oracleDbGcpConnectorId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OracleDbGcpKeyLifecycleStateQueryParam:
description: 'A filter to return only resources that match the specified lifecycle state. The state value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/OracleDbGcpKey/lifecycleState'
schema:
type: string
CompartmentIdQueryParam:
description: The [ID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: true
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource''s current etag value.
'
in: header
name: if-match
required: false
schema:
type: string
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
x-default-description: 'null'
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
SortOrderQueryParam:
description: The sort order to use, either 'asc' or 'desc'.
in: query
name: sortOrder
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: DESC
OracleDbGcpIdentityConnectorLifecycleStateQueryParam:
description: 'A filter to return only resources that match the specified lifecycle state. The state value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/OracleDbGcpIdentityConnector/lifecycleState'
schema:
type: string
OracleDbGcpKeyRingIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB GCP Key-Ring resource.
in: path
name: oracleDbGcpKeyRingId
required: true
schema:
type: string
maxLength: 255
minLength: 1
OracleDbGcpKeyRingLifecycleStateQueryParam:
description: 'A filter to return only resources that match the given lifecycle state. The
state value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/OracleDbGcpKeyRing/lifecycleState'
schema:
type: string
RetryTokenHeader:
description: 'A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.
Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.
For example, if a resource has been deleted and permanently purged from the system, a retry of the original creation request may be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
OracleDbGcpKeyIdQueryParam:
description: A filter to return Oracle DB Google Cloud Key resources.
in: query
name: oracleDbGcpKeyId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OracleDbGcpKeyDisplayNameQueryParam:
description: A filter to return Oracle DB Google Cloud Key resources that match the specified display name.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OracleDbGcpKeyIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Google Cloud Key resource.
in: path
name: oracleDbGcpKeyId
required: true
schema:
type: string
maxLength: 255
minLength: 1
OracleDbResourceIdQueryParam:
description: A filter to return Oracle DB Identity Connector resource that match the given resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
in: query
name: resourceId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
OracleDbGcpIdentityConnectorIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB GCP Identity Configuration Resource.
in: path
name: oracleDbGcpIdentityConnectorId
required: true
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
schemas:
OracleDbGcpKeySummary:
description: 'Oracle DB Google Cloud Key resource summary.
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment contains Oracle DB Google Cloud Key resource.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Google Cloud Key resource name.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpKeyId:
description: The Google Cloud ID of the Google Key, Google Key resource URL.
type: string
gcpKeyProperties:
description: Gcp Key properties
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the Oracle DB Google Cloud Key resource.
type: string
lifecycleState:
description: The current lifecycle state of the Oracle DB Google Key resource.
type: string
x-obmcs-enumref: '#/definitions/OracleDbGcpKey/lifecycleState'
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
type: string
oracleDbGcpKeyRingId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Google Cloud Key-Ring resource.
type: string
resourceType:
description: Key resource type.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Time when the Oracle DB Google Cloud Key was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle DB Google Cloud Key was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
type: object
OracleDbGcpKeyRingSummaryCollection:
description: List of OracleDbGcpKeyRingSummary resources.
properties:
items:
description: This list contains the summary of Oracle DB GCP Key-Ring resources.
items:
$ref: '#/components/schemas/OracleDbGcpKeyRingSummary'
type: array
required:
- items
type: object
OracleDbGcpKeySummaryCollection:
description: List of OracleDbGcpKeySummary resources.
properties:
items:
description: This list contains the summary of Oracle Google Cloud Key resources.
items:
$ref: '#/components/schemas/OracleDbGcpKeySummary'
type: array
required:
- items
type: object
Error:
description: Error information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error message.
type: string
required:
- code
- message
ChangeOracleDbGcpKeyRingCompartmentDetails:
description: Details of the new compartment to contain the Oracle DB GCP Key-Ring resource.
properties:
compartmentId:
description: The compartment [OCID](/Content/General/Concepts/identifiers.htm) where the Oracle DB GCP Key Ring resource resides.
maxLength: 255
minLength: 1
type: string
OracleDbGcpIdentityConnectorSummaryCollection:
description: List of OracleDbGcpIdentityConnectorSummary resources.
properties:
items:
description: This list contains the summary of Oracle DB GCP Identity Connector resources.
items:
$ref: '#/components/schemas/OracleDbGcpIdentityConnectorSummary'
type: array
required:
- items
type: object
OracleDbGcpIdentityConnector:
description: 'This resource is used to create and manage a GCP Identity Connector for Oracle Database running on Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).
The Identity Connector enables secure communication between Oracle Cloud and Google Cloud services.
'
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Oracle DB GCP Identity Connector resource.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB GCP Identity Connector resource name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpIdentityConnectivityStatus:
description: The current Connectivity status of GCP Identity Connector resource.
enum:
- CONNECTED
- DISCONNECTED
- PARTIALLY_CONNECTED
- UNKNOWN
type: string
gcpLocation:
description: GCP Location.
maxLength: 1024
minLength: 1
type: string
gcpNodes:
description: List of All VMs where GCP Identity Connector is configured for this VMCluster.
items:
$ref: '#/components/schemas/GcpNodes'
maxItems: 20
minItems: 0
type: array
gcpResourceServiceAgentId:
description: The ID of the GCP resource service agent.
maxLength: 1024
minLength: 1
type: string
gcpWorkloadIdentityPoolId:
description: The ID of the cloud GCP Workload Identity Pool.
maxLength: 1024
minLength: 1
type: string
gcpWorkloadIdentityProviderId:
description: The ID of the GCP Workload Identity Provider.
maxLength: 1024
minLength: 1
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB GCP Identity Connector resource.
maxLength: 255
minLength: 1
type: string
issuerUrl:
description: OIDC token issuer Url.
maxLength: 1024
minLength: 1
type: string
lifecycleState:
description: The current lifecycle state of the GCP Identity Connector resource.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
maxLength: 1024
minLength: 1
type: string
projectId:
description: Project id of the customer project.
maxLength: 64
minLength: 1
type: string
resourceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GCP VM Cluster resource.
maxLength: 1024
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Time when the Oracle DB GCP Identity Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle DB GCP Identity Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
required:
- id
- projectId
- issuerUrl
- compartmentId
- resourceId
- gcpLocation
- gcpWorkloadIdentityPoolId
- gcpWorkloadIdentityProviderId
- gcpResourceServiceAgentId
type: object
GcpNodes:
description: 'GCP Identity Connector node details.
'
properties:
hostId:
description: Host ID.
maxLength: 255
minLength: 1
type: string
hostName:
description: Host Name or Identity Connector name.
maxLength: 255
minLength: 1
type: string
status:
description: The current status of the GCP Identity Connector resource.
enum:
- CONNECTED
- DISCONNECTED
- UNKNOWN
type: string
timeLastChecked:
description: 'time when the GCP Identity Connector''s status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
type: object
CreateOracleDbGcpIdentityConnectorDetails:
description: 'Creates Oracle DB GCP Identity Connector resource.
'
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Oracle DB GCP Identity Connector resource.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Google GCP Identity Connector resource name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpLocation:
description: GCP Location.
maxLength: 1024
minLength: 1
type: string
gcpResourceServiceAgentId:
description: The ID of the GCP resource service agent.
maxLength: 1024
minLength: 1
type: string
gcpWorkloadIdentityPoolId:
description: The ID of the cloud GCP Workload Identity Pool.
maxLength: 1024
minLength: 1
type: string
gcpWorkloadIdentityProviderId:
description: The ID of the GCP Workload Identity Provider.
maxLength: 1024
minLength: 1
type: string
issuerUrl:
description: OIDC token issuer Url
maxLength: 1024
minLength: 1
type: string
projectId:
description: Project id of the customer project.
maxLength: 64
minLength: 1
type: string
resourceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GCP VM Cluster resource.
maxLength: 1024
minLength: 1
type: string
required:
- compartmentId
- displayName
- projectId
- issuerUrl
- resourceId
- gcpLocation
- gcpWorkloadIdentityPoolId
- gcpWorkloadIdentityProviderId
- gcpResourceServiceAgentId
type: object
UpdateOracleDbGcpIdentityConnectorDetails:
description: 'This object is about to provide input params to create Oracle DB GCP Identity Connector resource.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Google GCP Identity Connector resource name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpLocation:
description: GCP Location.
maxLength: 1024
minLength: 1
type: string
gcpResourceServiceAgentId:
description: The ID of the GCP resource service agent.
maxLength: 1024
minLength: 1
type: string
gcpWorkloadIdentityPoolId:
description: The ID of the cloud GCP Workload Identity Pool.
maxLength: 1024
minLength: 1
type: string
gcpWorkloadIdentityProviderId:
description: The ID of the GCP Workload Identity Provider.
maxLength: 1024
minLength: 1
type: string
issuerUrl:
description: OIDC token issuer Url
maxLength: 1024
minLength: 1
type: string
projectId:
description: Project ID of the customer project.
maxLength: 64
minLength: 1
type: string
resourceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GCP VM Cluster resource.
maxLength: 1024
minLength: 1
type: string
type: object
ChangeOracleDbGcpIdentityConnectorCompartmentDetails:
description: Details of the new compartment to contain the Oracle DB GCP Identity Connector resource.
properties:
compartmentId:
description: The OCID of the compartment that contains the Oracle DB GCP Identity Connector resource.
maxLength: 255
minLength: 1
type: string
OracleDbGcpKey:
description: 'Oracle DB Google Cloud Key resource.
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Google Key resource.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Display name of Oracle DB Google Key resource.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpKeyId:
description: TThe Google Cloud Key ID and Key URL associated with the Google Key under the specified Key Ring resource.
maxLength: 1024
minLength: 1
type: string
gcpKeyProperties:
description: Gcp Key properties
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Google Key resource.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current lifecycle state of the Oracle DB Google Key resource.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
maxLength: 1024
minLength: 1
type: string
oracleDbGcpKeyRingId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Google Cloud Key-Ring resource.
maxLength: 255
minLength: 1
type: string
resourceType:
description: Key resource type.
maxLength: 1024
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Time when the Oracle DB Google Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle DB Google Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
required:
- id
- compartmentId
- oracleDbGcpKeyRingId
type: object
OracleDbGcpKeyRing:
description: 'Oracle DB GCP Key Ring resource object.
'
properties:
compartmentId:
description: The compartment [OCID](/Content/General/Concepts/identifiers.htm) where the Oracle DB GCP Key Ring resource resides.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Display name of DB GCP Key Ring resource.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpKeyRingId:
description: GCP Key Ring ID.
maxLength: 2048
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB GCP Key Ring resource.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The lifecycle state of the Oracle DB GCP Key Ring resource.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
maxLength: 1024
minLength: 1
type: string
location:
description: Location of the GCP Key Ring resource.
maxLength: 255
minLength: 1
type: string
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Oracle DB GCP Identity Connector resource resides.
maxLength: 255
minLength: 1
type: string
properties:
additionalProperties:
type: string
description: Oracle DB GCP Key Ring resource's properties.
maxProperties: 20
type: object
replicationMetadata:
$ref: '#/components/schemas/ReplicationMetadata'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Time when the DB GCP Key Ring resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the DB GCP Key Ring resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''
'
format: date-time
type: string
type:
description: Oracle DB GCP Key Ring resource Type.
maxLength: 255
minLength: 1
type: string
required:
- id
- compartmentId
type: object
OracleDbGcpKeyRingSummary:
description: 'Oracle Oracle DB GCP Key-Ring resource summary.
'
properties:
compartmentId:
description: The compartment [OCID](/Content/General/Concepts/identifiers.htm) where the Oracle DB GCP Key Ring resource resides.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Display name of DB GCP Key Ring resource.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpKeyRingId:
description: GCP Key Ring ID.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB GCP Key Ring resource.
type: string
lifecycleState:
description: The lifecycle state of the Oracle DB GCP Key Ring resource.
type: string
x-obmcs-enumref: '#/definitions/OracleDbGcpKeyRing/lifecycleState'
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
type: string
location:
description: Location of the GCP Key Ring resource.
type: string
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Oracle DB GCP Identity Connector resource resides.
type: string
properties:
additionalProperties:
type: string
description: Oracle GCP Key Ring resource's properties.
maxProperties: 20
type: object
replicationMetadata:
$ref: '#/components/schemas/ReplicationMetadata'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Time when the Oracle Oracle DB GCP Key Ring was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle Oracle DB GCP Key Ring was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''
'
format: date-time
type: string
type:
description: Key Ring resource type.
type: string
type: object
RefreshOracleDbGcpKeyRingDetails:
description: Details for to refresh Oracle DB GCP Key Ring resource.
properties:
oracleDbGcpConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB GCP Connector resource.
maxLength: 255
minLength: 1
type: string
UpdateOracleDbGcpKeyRingDetails:
description: 'This object is about to provide input params to update Oracle DB GCP Key-Ring resource.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Display name of DB GCP Key Ring resource.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
type: object
ReplicateOracleDbGcpKeyRingDetails:
description: 'Replicate Oracle GCP Keyring resource.
'
properties:
action:
description: Action for replicate Resource.
enum:
- CREATE
- DELETE
type: string
x-obmcs-top-level-enum: '#/definitions/ReplicationActions'
targetRegion:
description: The Destination region where Oracle GCP Keyring resource will replicate.
type: string
required:
- targetRegion
type: object
ReplicationMetadata:
description: 'Replication metadata, it has information about replication and target region.
'
properties:
replicationDetails:
description: List of all regions and their respective resource ID.
items:
$ref: '#/components/schemas/ReplicationDetails'
maxItems: 20
minItems: 0
type: array
type: object
OracleDbGcpIdentityConnectorSummary:
description: 'Oracle DB GCP Identity Connector resource summary.
'
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Oracle DB GCP Identity Connector resource.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB GCP Identity Connector resource name.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpIdentityConnectivityStatus:
description: The current lifecycle state of the GCP Identity Connector resource.
type: string
x-obmcs-enumref: '#/definitions/OracleDbGcpIdentityConnector/gcpIdentityConnectivityStatus'
gcpLocation:
description: GCP Location.
type: string
gcpNodes:
description: List of All VMs where GCP Identity Connector is configured for this VMCluster.
items:
$ref: '#/components/schemas/GcpNodes'
type: array
gcpResourceServiceAgentId:
description: The ID of the GCP resource service agent.
type: string
gcpWorkloadIdentityPoolId:
description: The ID of the cloud GCP Workload Identity Pool.
type: string
gcpWorkloadIdentityProviderId:
description: The ID of the GCP Workload Identity Provider.
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB GCP Identity Connector resource.
type: string
issuerUrl:
description: OIDC token issuer Url
type: string
lifecycleState:
description: The current lifecycle state of the GCP Identity Connector resource.
type: string
x-obmcs-enumref: '#/definitions/OracleDbGcpIdentityConnector/lifecycleState'
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
type: string
projectId:
description: Project id of the customer project.
type: string
resourceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GCP VM Cluster resource.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Time when the Oracle DB GCP Identity Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle DB GCP Identity Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
type: object
CreateOracleDbGcpKeyRingDetails:
description: 'This object is about to provide input params to create Oracle DB GCP Key-Ring Details.
'
properties:
compartmentId:
description: The compartment [OCID](/Content/General/Concepts/identifiers.htm) where the Oracle DB GCP Key Ring resource resides.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Display name of DB GCP Key Ring resource.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gcpKeyRingId:
description: GCP Key Ring ID.
maxLength: 2048
minLength: 1
type: string
location:
description: Location of the GCP Key Ring resource.
maxLength: 255
minLength: 1
type: string
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Oracle DB GCP Identity Connector resource resides.
maxLength: 255
minLength: 1
type: string
properties:
additionalProperties:
type: string
description: Oracle DB GCP Key Ring resource's properties.
maxProperties: 20
type: object
type:
description: Oracle DB GCP Key Ring resource Type.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- displayName
- oracleDbConnectorId
type: object
ReplicationDetails:
description: 'Replication metadata details, targeted regions and respective replication state, time created or time when it was updated.
'
properties:
replicationState:
description: The lifecycle state of the Oracle DB Azure Vault resource.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
targetRegion:
description: The target region, where resource is replicated.
maxLength: 255
minLength: 0
type: string
timeCreated:
description: 'Time when the Replication was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Replication was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''
'
format: date-time
type: string
type: object
responses:
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain. For
important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
type: integer
x-properties:
content-location:
description: URI of the resource
format: uri-reference
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
location:
description: URI of the resource
format: uri-reference
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a system tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.db.mci.azure.identity